More comment fixes

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

diff --git a/api/v3/LineItem.php b/api/v3/LineItem.php
index 6460908d19314bdaf6a01b8cef45c317d5e86c9d..c44c4e1ab5572fa7e5943a79d89f70774013b649 100644 (file)
--- a/api/v3/LineItem.php
+++ b/api/v3/LineItem.php
@@ -1,5 +1,4 @@
 <?php
-/*
 /*
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
@@ -24,11 +23,11 @@
  | 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 group functions
+ * File for the CiviCRM APIv3 line item functions
  *
  * @package CiviCRM_APIv3
  * @subpackage API_LineItem
@@ -36,27 +35,24 @@
  */
 
 /**
- * Create or update a line_item
+ * Create or update a line_item.
  *
  * @param array $params
- *   Associative array of property.
- *                       name/value pairs to insert in new 'line_item'
- * @example LineItemCreate.php Std Create example
+ *   Array of property name/value pairs to insert in new 'line_item'
  *
  * @return array
-   *   api result array
- * {@getfields line_item_create}
- * @access public
+ *   api result array
  */
 function civicrm_api3_line_item_create($params) {
-  $params = CRM_Contribute_BAO_Contribution::checkTaxAmount($params,True);
+  $params = CRM_Contribute_BAO_Contribution::checkTaxAmount($params, TRUE);
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $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.
  */
@@ -69,35 +65,31 @@ function _civicrm_api3_line_item_create_spec(&$params) {
 }
 
 /**
- * Returns array of line_items  matching a set of one or more group properties
+ * Returns array of line_items  matching a set of one or more group properties.
  *
  * @param array $params
  *   Array of one or more valid property_name=>value pairs. If $params is set.
- *  as null, all line_items will be returned (default limit is 25)
+ *   as null, all line_items will be returned (default limit is 25)
  *
  * @return array
-   *   Array of matching line_items
- * {@getfields line_item_get}
- * @access public
+ *   Array of matching line_items
  */
 function civicrm_api3_line_item_get($params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
 
 /**
- * delete an existing line_item
+ * Delete an existing line_item.
  *
  * This method is used to delete any existing line_item. id of the group
  * to be deleted is required field in $params array
  *
  * @param array $params
  *   Array containing id of the group.
- *  to be deleted
+ *   to be deleted
  *
  * @return array
-   *   API result array
- * {@getfields line_item_delete}
- * @access public
+ *   API result array
  */
 function civicrm_api3_line_item_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);