--CRM-16187, fixed jenkin warnings

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

diff --git a/api/v3/RelationshipType.php b/api/v3/RelationshipType.php
index 45bd1f4d8a3e8651cf4719b1bff5116fac363315..01fbebc7384ff12c85ccf3987509adae75542fbe 100644 (file)
--- a/api/v3/RelationshipType.php
+++ b/api/v3/RelationshipType.php
@@ -3,7 +3,7 @@
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -26,21 +26,16 @@
  */
 
 /**
- * new version of civicrm apis. See blog post at
- * http://civicrm.org/node/131
+ * This api exposes CiviCRM relationship types.
  *
  * @package CiviCRM_APIv3
- * @subpackage API_Contact
- * @copyright CiviCRM LLC (c) 2004-2014
- * $Id: Contact.php 30415 2010-10-29 12:02:47Z shot $
- *
  */
 
 /**
- * create relationship type
+ * Create relationship type.
  *
  * @param array $params
- *   Associative array of property name/value pairs to insert in new relationship type.
+ *   Array per getfields metadata.
  *
  * @return array
  */
@@ -70,7 +65,7 @@ function civicrm_api3_relationship_type_create($params) {
 
   _civicrm_api3_object_to_array($relationType, $relType[$relationType->id]);
 
-  return civicrm_api3_create_success($relType, $params, 'relationship_type', 'create', $relationType);
+  return civicrm_api3_create_success($relType, $params, 'RelationshipType', 'create', $relationType);
 }
 
 /**
@@ -79,7 +74,7 @@ function civicrm_api3_relationship_type_create($params) {
  * The metadata is used for setting defaults, documentation & validation.
  *
  * @param array $params
- *   Array or parameters determined by getfields.
+ *   Array of parameters determined by getfields.
  */
 function _civicrm_api3_relationship_type_create_spec(&$params) {
   $params['contact_type_a']['api.required'] = 1;
@@ -90,11 +85,10 @@ function _civicrm_api3_relationship_type_create_spec(&$params) {
 }
 
 /**
- * get all relationship type
- * retruns  An array of Relationship_type
- * {@getfields RelationshipType_get}
- * @example RelationshipTypeGet.php
+ * Get all relationship types.
+ *
  * @param array $params
+ *
  * @return array
  */
 function civicrm_api3_relationship_type_get($params) {
@@ -102,7 +96,7 @@ function civicrm_api3_relationship_type_get($params) {
 }
 
 /**
- * Delete a relationship type delete
+ * Delete a relationship type.
  *
  * @param array $params
  *
@@ -114,9 +108,12 @@ function civicrm_api3_relationship_type_delete($params) {
 }
 
 /**
+ * Get list defaults for relationship types.
+ *
  * @see _civicrm_api3_generic_getlist_defaults
  *
  * @param array $request
+ *
  * @return array
  */
 function _civicrm_api3_relationship_type_getlist_defaults($request) {