Update debugging page text

[civicrm-core.git] / api / v3 / Relationship.php

diff --git a/api/v3/Relationship.php b/api/v3/Relationship.php
index ff0dfd1f59ee5d2c5325f5269326fd2ef1a2d7e2..b4e20a2558b3124b65350ee57d1f7dc7db553ff1 100644 (file)
--- a/api/v3/Relationship.php
+++ b/api/v3/Relationship.php
@@ -23,31 +23,24 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
- * File for the CiviCRM APIv3 relationship functions
+ * This api exposes CiviCRM relationships.
  *
  * @package CiviCRM_APIv3
- * @subpackage API_Relationship
- *
- * @copyright CiviCRM LLC (c) 2004-2014
- * @version $Id: Relationship.php 30486 2010-11-02 16:12:09Z shot $
- *
  */
 
 /**
- * Add or update a relationship
+ * Add or update a relationship.
  *
  * @param array $params
  *   Input parameters.
  *
  * @throws API_Exception
- * @example RelationshipCreate.php Std Create example
  *
  * @return array
  *   API Result Array
- *   {@getfields relationship_create}
  */
 function civicrm_api3_relationship_create($params) {
   _civicrm_api3_handle_relationship_type($params);
@@ -55,10 +48,10 @@ function civicrm_api3_relationship_create($params) {
 }
 
 /**
- * Adjust Metadata for Create action
+ * Adjust Metadata for Create action.
  *
  * @param array $params
- *   Array or parameters determined by getfields.
+ *   Array of parameters determined by getfields.
  */
 function _civicrm_api3_relationship_create_spec(&$params) {
   $params['contact_id_a']['api.required'] = 1;
@@ -68,15 +61,12 @@ function _civicrm_api3_relationship_create_spec(&$params) {
 }
 
 /**
- * Delete a relationship
+ * Delete a relationship.
  *
  * @param array $params
  *
  * @return array
  *   API Result Array
- *   {@getfields relationship_delete}
- * @example RelationshipDelete.php Delete Example
- *
  */
 function civicrm_api3_relationship_delete($params) {
 
@@ -96,19 +86,17 @@ function civicrm_api3_relationship_delete($params) {
 }
 
 /**
- * get the relationship
+ * Get one or more relationship/s.
  *
  * @param array $params
  *   Input parameters.
+ *
  * @todo  Result is inconsistent depending on whether contact_id is passed in :
  * -  if you pass in contact_id - it just returns all relationships for 'contact_id'
  * -  if you don't pass in contact_id then it does a filter on the relationship table (DAO based search)
  *
  * @return array
  *   API Result Array
- *   {@getfields relationship_get}
- * @example RelationshipGet.php
- * @access  public
  */
 function civicrm_api3_relationship_get($params) {
   $options = _civicrm_api3_get_options_from_params($params);
@@ -142,7 +130,7 @@ function civicrm_api3_relationship_get($params) {
 }
 
 /**
- * legacy handling for relationship_type parameter
+ * Legacy handling for relationship_type parameter.
  *
  * @param array $params
  *   Associative array of property name/value.