GH-26255: Add class descriptions to satisfy codesniff rules

Matthew O'Loughlin · Matthew O'Loughlin · commit 5e69e824709d · 2020-01-08T09:59:31.000+10:30
diff --git a/app/code/Magento/CacheInvalidate/Model/PurgeCache.php b/app/code/Magento/CacheInvalidate/Model/PurgeCache.php
@@ -8,7 +8,7 @@
 use Magento\Framework\Cache\InvalidateLogger;
 
 /**
- * Class PurgeCache
+ * Invalidate external HTTP cache(s) based on tag pattern
  */
 class PurgeCache
 {
diff --git a/app/code/Magento/CacheInvalidate/Observer/FlushAllCacheObserver.php b/app/code/Magento/CacheInvalidate/Observer/FlushAllCacheObserver.php
@@ -8,8 +8,7 @@
 use Magento\Framework\Event\ObserverInterface;
 
 /**
- * Class FlushAllCacheObserver
- * @package Magento\CacheInvalidate\Observer
+ * Clear configured Varnish hosts when triggering a full cache flush (e.g. from the Cache Management admin dashboard)
  */
 class FlushAllCacheObserver implements ObserverInterface
 {
diff --git a/app/code/Magento/CacheInvalidate/Observer/InvalidateVarnishObserver.php b/app/code/Magento/CacheInvalidate/Observer/InvalidateVarnishObserver.php
@@ -8,8 +8,7 @@
 use Magento\Framework\Event\ObserverInterface;
 
 /**
- * Class InvalidateVarnishObserver
- * @package Magento\CacheInvalidate\Observer
+ * Trigger invalidations on configured HTTP cache hosts upon cache_clean_by_tags
  */
 class InvalidateVarnishObserver implements ObserverInterface
 {

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@`
`8`	`8`	`use Magento\Framework\Cache\InvalidateLogger;`
`9`	`9`
`10`	`10`	`/**`
`11`		`- * Class PurgeCache`
	`11`	`+ * Invalidate external HTTP cache(s) based on tag pattern`
`12`	`12`	`*/`
`13`	`13`	`class PurgeCache`
`14`	`14`	`{`
Original file line number	Diff line number	Diff line change
`@@ -8,8 +8,7 @@`
`8`	`8`	`use Magento\Framework\Event\ObserverInterface;`
`9`	`9`
`10`	`10`	`/**`
`11`		`- * Class FlushAllCacheObserver`
`12`		`- * @package Magento\CacheInvalidate\Observer`
	`11`	`+ * Clear configured Varnish hosts when triggering a full cache flush (e.g. from the Cache Management admin dashboard)`
`13`	`12`	`*/`
`14`	`13`	`class FlushAllCacheObserver implements ObserverInterface`
`15`	`14`	`{`