Merge pull request #9573 from totten/master-inheritdoc

(NFC) CRM_*_Tokens - Reduce redundant docs
civicrm · Dec 29, 2016 · d96ee4e · d96ee4e
2 parents 6ede0e6 + 298795c
commit d96ee4e
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 60 deletions.
diff --git a/CRM/Activity/Tokens.php b/CRM/Activity/Tokens.php
@@ -56,11 +56,7 @@ public function __construct() {
   }
 
   /**
-   * Check is active.
-   *
-   * @param \Civi\Token\TokenProcessor $processor
-   *
-   * @return bool
+   * @inheritDoc
    */
   public function checkActive(\Civi\Token\TokenProcessor $processor) {
     // Extracted from scheduled-reminders code. See the class description.
@@ -69,6 +65,9 @@ public function checkActive(\Civi\Token\TokenProcessor $processor) {
       && $processor->context['actionMapping']->getEntity() === 'civicrm_activity';
   }
 
+  /**
+   * @inheritDoc
+   */
   public function alterActionScheduleQuery(\Civi\ActionSchedule\Event\MailingQueryEvent $e) {
     if ($e->mapping->getEntity() !== 'civicrm_activity') {
       return;
@@ -94,17 +93,7 @@ public function alterActionScheduleQuery(\Civi\ActionSchedule\Event\MailingQuery
   }
 
   /**
-   * Evaluate the content of a single token.
-   *
-   * @param \Civi\Token\TokenRow $row
-   *   The record for which we want token values.
-   * @param string $entity
-   * @param string $field
-   *   The name of the token field.
-   * @param mixed $prefetch
-   *   Any data that was returned by the prefetch().
-   *
-   * @return mixed
+   * @inheritDoc
    */
   public function evaluateToken(\Civi\Token\TokenRow $row, $entity, $field, $prefetch = NULL) {
     $actionSearchResult = $row->context['actionSearchResult'];

diff --git a/CRM/Contribute/Tokens.php b/CRM/Contribute/Tokens.php
@@ -109,18 +109,7 @@ public function alterActionScheduleQuery(\Civi\ActionSchedule\Event\MailingQuery
   }
 
   /**
-   * Evaluate the content of a single token.
-   *
-   * @param \Civi\Token\TokenRow $row
-   *   The record for which we want token values.
-   * @param string $entity
-   * @param string $field
-   *   The name of the token field.
-   * @param mixed $prefetch
-   *   Any data that was returned by the prefetch().
-   *
-   * @return mixed
-   * @throws \CRM_Core_Exception
+   * @inheritDoc
    */
   public function evaluateToken(\Civi\Token\TokenRow $row, $entity, $field, $prefetch = NULL) {
     $actionSearchResult = $row->context['actionSearchResult'];

diff --git a/CRM/Event/Tokens.php b/CRM/Event/Tokens.php
@@ -63,11 +63,7 @@ public function __construct() {
   }
 
   /**
-   * Check something about being active.
-   *
-   * @param \Civi\Token\TokenProcessor $processor
-   *
-   * @return bool
+   * @inheritDoc
    */
   public function checkActive(\Civi\Token\TokenProcessor $processor) {
     // Extracted from scheduled-reminders code. See the class description.
@@ -95,17 +91,7 @@ public function alterActionScheduleQuery(\Civi\ActionSchedule\Event\MailingQuery
   }
 
   /**
-   * Evaluate the content of a single token.
-   *
-   * @param \Civi\Token\TokenRow $row
-   *   The record for which we want token values.
-   * @param string $entity
-   * @param string $field
-   *   The name of the token field.
-   * @param mixed $prefetch
-   *   Any data that was returned by the prefetch().
-   *
-   * @return mixed
+   * @inheritDoc
    */
   public function evaluateToken(\Civi\Token\TokenRow $row, $entity, $field, $prefetch = NULL) {
     $actionSearchResult = $row->context['actionSearchResult'];

diff --git a/CRM/Member/Tokens.php b/CRM/Member/Tokens.php
@@ -56,11 +56,7 @@ public function __construct() {
   }
 
   /**
-   * Is token active.
-   *
-   * @param \Civi\Token\TokenProcessor $processor
-   *
-   * @return bool
+   * @inheritDoc
    */
   public function checkActive(\Civi\Token\TokenProcessor $processor) {
     // Extracted from scheduled-reminders code. See the class description.
@@ -83,17 +79,7 @@ public function alterActionScheduleQuery(\Civi\ActionSchedule\Event\MailingQuery
   }
 
   /**
-   * Evaluate the content of a single token.
-   *
-   * @param \Civi\Token\TokenRow $row
-   *   The record for which we want token values.
-   * @param string $entity
-   * @param string $field
-   *   The name of the token field.
-   * @param mixed $prefetch
-   *   Any data that was returned by the prefetch().
-   *
-   * @return mixed
+   * @inheritDoc
    */
   public function evaluateToken(\Civi\Token\TokenRow $row, $entity, $field, $prefetch = NULL) {
     $actionSearchResult = $row->context['actionSearchResult'];