CRM-15856 - Mailing API - Enforce required mail-merge tokens.

[civicrm-core.git] / tests / phpunit / CiviTest / Contact.php

diff --git a/tests/phpunit/CiviTest/Contact.php b/tests/phpunit/CiviTest/Contact.php
index b43c490db9ac9fa4b45c6e9e5a74b28d55c9aa18..03c65c488d322d81865b58176d220087fc473435 100644 (file)
--- a/tests/phpunit/CiviTest/Contact.php
+++ b/tests/phpunit/CiviTest/Contact.php
@@ -5,7 +5,7 @@
  */
 class Contact extends CiviUnitTestCase {
   /**
-   * Helper function to create
+   * Helper function to create.
    * a contact
    *
    * @param array $params
@@ -47,7 +47,8 @@ class Contact extends CiviUnitTestCase {
    * a contact of type Household
    *
    * @param array $params
-   * @return mixed $contactID id of created Household
+   * @return int
+   *   id of created Household
    */
   public static function createHousehold($params = NULL) {
     //compose the params, when not passed
@@ -68,7 +69,8 @@ class Contact extends CiviUnitTestCase {
    * a contact of type Organisation
    *
    * @param array $params
-   * @return mixed $contactID id of created Organisation
+   * @return int
+   *   id of created Organisation
    */
   public static function createOrganisation($params = NULL) {
     //compose the params, when not passed
@@ -85,15 +87,16 @@ class Contact extends CiviUnitTestCase {
   }
 
   /**
-   * Helper function to delete a contact
+   * Helper function to delete a contact.
    *
    * @param int $contactID
    *   Id of the contact to delete.
-   * @return boolean
+   * @return bool
    *   true if contact deleted, false otherwise
    */
   public static function delete($contactID) {
     require_once 'CRM/Contact/BAO/Contact.php';
     return CRM_Contact_BAO_Contact::deleteContact($contactID);
   }
+
 }