more comment fixes

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

diff --git a/api/v3/RelationshipType.php b/api/v3/RelationshipType.php
index dc8da5a358f0b96a881b07e6eeaeba79ab835704..7e2eb908e89d4b7c2963d99d5a85812270e3847e 100644 (file)
--- a/api/v3/RelationshipType.php
+++ b/api/v3/RelationshipType.php
@@ -33,14 +33,13 @@
  * @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
  */
@@ -74,9 +73,10 @@ function civicrm_api3_relationship_type_create($params) {
 }
 
 /**
- * Adjust Metadata for Create action
+ * Adjust Metadata for Create action.
+ *
+ * The metadata is used for setting defaults, documentation & validation.
  *
- * The metadata is used for setting defaults, documentation & validation
  * @param array $params
  *   Array or parameters determined by getfields.
  */
@@ -89,12 +89,10 @@ function _civicrm_api3_relationship_type_create_spec(&$params) {
 }
 
 /**
- * get all relationship type
- * retruns  An array of Relationship_type
- * @access  public
- * {@getfields RelationshipType_get}
- * @example RelationshipTypeGet.php
+ * Get all relationship types.
+ *
  * @param array $params
+ *
  * @return array
  */
 function civicrm_api3_relationship_type_get($params) {
@@ -102,7 +100,7 @@ function civicrm_api3_relationship_type_get($params) {
 }
 
 /**
- * Delete a relationship type delete
+ * Delete a relationship type.
  *
  * @param array $params
  *
@@ -114,6 +112,8 @@ function civicrm_api3_relationship_type_delete($params) {
 }
 
 /**
+ * Get list defaults for relationship types.
+ *
  * @see _civicrm_api3_generic_getlist_defaults
  *
  * @param array $request
@@ -124,4 +124,4 @@ function _civicrm_api3_relationship_type_getlist_defaults($request) {
     'label_field' => 'label_a_b',
     'search_field' => 'label_a_b',
   );
-}
\ No newline at end of file
+}