Fix up doc blocks in event decorators.

cakephp · Jul 6, 2016 · 0a5f611 · 0a5f611
1 parent 9774b40
commit 0a5f611
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 12 deletions.
diff --git a/src/Event/Decorator/AbstractDecorator.php b/src/Event/Decorator/AbstractDecorator.php
@@ -14,6 +14,9 @@
  */
 namespace Cake\Event\Decorator;
 
+/**
+ * Common base class for event decorator subclasses.
+ */
 abstract class AbstractDecorator
 {
 

diff --git a/src/Event/Decorator/ConditionDecorator.php b/src/Event/Decorator/ConditionDecorator.php
@@ -19,13 +19,15 @@
 
 /**
  * Event Condition Decorator
+ *
+ * Use this decorator to allow your event listener to only
+ * be invoked if the `if` and/or `unless` conditions pass.
  */
 class ConditionDecorator extends AbstractDecorator
 {
 
     /**
-     * @inheritdoc
-     * @return mixed
+     * {@inheritDoc}
      */
     public function __invoke()
     {

diff --git a/src/Event/Decorator/SubjectFilterDecorator.php b/src/Event/Decorator/SubjectFilterDecorator.php
@@ -19,13 +19,18 @@
 
 /**
  * Event Subject Filter Decorator
+ *
+ * Use this decorator to allow your event listener to only
+ * be invoked if event subject matches the `allowedSubject` option.
+ *
+ * The `allowedSubject` option can be a list of class names, if you want
+ * to check multiple classes.
  */
 class SubjectFilterDecorator extends AbstractDecorator
 {
 
     /**
-     * @inheritdoc
-     * @return mixed
+     * {@inheritDoc}
      */
     public function __invoke()
     {

diff --git a/tests/TestCase/Event/Decorator/ConditionDecoratorTest.php b/tests/TestCase/Event/Decorator/ConditionDecoratorTest.php
@@ -1,9 +1,5 @@
 <?php
 /**
- * EventTest file
- *
- * Test Case for Event class
- *
  * CakePHP : Rapid Development Framework (http://cakephp.org)
  * Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
  *

diff --git a/tests/TestCase/Event/Decorator/SubjectFilterDecoratorTest.php b/tests/TestCase/Event/Decorator/SubjectFilterDecoratorTest.php
@@ -1,9 +1,5 @@
 <?php
 /**
- * EventTest file
- *
- * Test Case for Event class
- *
  * CakePHP : Rapid Development Framework (http://cakephp.org)
  * Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
  *