Merge pull request #5182 from colemanw/Cleanup

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

diff --git a/tests/phpunit/CiviTest/Contact.php b/tests/phpunit/CiviTest/Contact.php
index 7d00f7ca27554ef106bf85bce381c6c2995a75d3..03c65c488d322d81865b58176d220087fc473435 100644 (file)
--- a/tests/phpunit/CiviTest/Contact.php
+++ b/tests/phpunit/CiviTest/Contact.php
@@ -5,12 +5,13 @@
  */
 class Contact extends CiviUnitTestCase {
   /**
-   * Helper function to create
+   * Helper function to create.
    * a contact
    *
    * @param array $params
    *
-   * @return int $contactID id of created contact
+   * @return int
+   *   $contactID id of created contact
    */
   public static function create($params) {
     require_once "CRM/Contact/BAO/Contact.php";
@@ -23,7 +24,8 @@ class Contact extends CiviUnitTestCase {
    * a contact of type Individual
    *
    * @param array $params
-   * @return int $contactID id of created Individual
+   * @return int
+   *   $contactID id of created Individual
    */
   public static function createIndividual($params = NULL) {
     //compose the params, when not passed
@@ -45,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
@@ -66,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
@@ -83,13 +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 true if contact deleted, false otherwise
+   * @param int $contactID
+   *   Id of the contact to delete.
+   * @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);
   }
+
 }