From 9c2c0cddb9a227f5bef7e86c36a6866d3256ea3f Mon Sep 17 00:00:00 2001
From: Tim Otten <totten@civicrm.org>
Date: Tue, 26 Jan 2016 18:21:26 -0800
Subject: [PATCH] CRM_Contribute_ActionMapping_ByTypeTest - Comments

---
 .../Contribute/ActionMapping/ByTypeTest.php    | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/tests/phpunit/CRM/Contribute/ActionMapping/ByTypeTest.php b/tests/phpunit/CRM/Contribute/ActionMapping/ByTypeTest.php
index 44086cffe4..bbc918759e 100644
--- a/tests/phpunit/CRM/Contribute/ActionMapping/ByTypeTest.php
+++ b/tests/phpunit/CRM/Contribute/ActionMapping/ByTypeTest.php
@@ -117,6 +117,9 @@ class CRM_Contribute_ActionMapping_ByTypeTest extends \Civi\ActionSchedule\Abstr
     return $cs;
   }
 
+  /**
+   * Create a contribution record for Alice with type "Member Dues".
+   */
   public function addAliceDues() {
     $this->callAPISuccess('Contribution', 'create', array(
       'contact_id' => $this->contacts['alice']['id'],
@@ -138,6 +141,9 @@ class CRM_Contribute_ActionMapping_ByTypeTest extends \Civi\ActionSchedule\Abstr
     ));
   }
 
+  /**
+   * Create a contribution record for Bob with type "Donation".
+   */
   public function addBobDonation() {
     $this->callAPISuccess('Contribution', 'create', array(
       'contact_id' => $this->contacts['bob']['id'],
@@ -152,6 +158,9 @@ class CRM_Contribute_ActionMapping_ByTypeTest extends \Civi\ActionSchedule\Abstr
     ));
   }
 
+  /**
+   * Schedule message delivery for contributions of type "Member Dues".
+   */
   public function scheduleForDues() {
     $this->schedule->mapping_id = CRM_Contribute_ActionMapping_ByType::MAPPING_ID;
     $this->schedule->start_action_date = 'receive_date';
@@ -159,6 +168,9 @@ class CRM_Contribute_ActionMapping_ByTypeTest extends \Civi\ActionSchedule\Abstr
     $this->schedule->entity_status = CRM_Utils_Array::implodePadded(array(1));
   }
 
+  /**
+   * Schedule message delivery for contributions of type "Donation".
+   */
   public function scheduleForDonation() {
     $this->schedule->mapping_id = CRM_Contribute_ActionMapping_ByType::MAPPING_ID;
     $this->schedule->start_action_date = 'receive_date';
@@ -166,6 +178,9 @@ class CRM_Contribute_ActionMapping_ByTypeTest extends \Civi\ActionSchedule\Abstr
     $this->schedule->entity_status = CRM_Utils_Array::implodePadded(NULL);
   }
 
+  /**
+   * Schedule message delivery for any contribution, regardless of type.
+   */
   public function scheduleForAny() {
     $this->schedule->mapping_id = CRM_Contribute_ActionMapping_ByType::MAPPING_ID;
     $this->schedule->start_action_date = 'receive_date';
@@ -173,6 +188,9 @@ class CRM_Contribute_ActionMapping_ByTypeTest extends \Civi\ActionSchedule\Abstr
     $this->schedule->entity_status = CRM_Utils_Array::implodePadded(NULL);
   }
 
+  /**
+   * Schedule message delivery to the 'soft credit' assignee.
+   */
   public function scheduleForSoftCreditor() {
     $this->schedule->mapping_id = CRM_Contribute_ActionMapping_ByType::MAPPING_ID;
     $this->schedule->start_action_date = 'receive_date';
-- 
2.25.1