Merge pull request #6251 from LevityNL/master

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

diff --git a/api/v3/LineItem.php b/api/v3/LineItem.php
index 8e3f152c1ef39d5bf810efcd9b2200e743e06f18..9a025c7fcacfb43891fcebce8c56af00a285b13d 100644 (file)
--- a/api/v3/LineItem.php
+++ b/api/v3/LineItem.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.                                    |
  |                                                                    |
@@ -27,20 +27,18 @@
 
 
 /**
- * File for the CiviCRM APIv3 group functions
+ * This api exposes CiviCRM LineItem records.
+ *
+ * Line items are sub-components of a complete financial transaction record.
  *
  * @package CiviCRM_APIv3
- * @subpackage API_LineItem
- * @copyright CiviCRM LLC (c) 20042012
  */
 
 /**
- * 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
@@ -56,7 +54,7 @@ function civicrm_api3_line_item_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_line_item_create_spec(&$params) {
   $params['entity_id']['api.required'] = 1;
@@ -67,7 +65,7 @@ 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.
@@ -81,14 +79,12 @@ function civicrm_api3_line_item_get($params) {
 }
 
 /**
- * delete an existing line_item
+ * Delete an existing LineItem.
  *
- * This method is used to delete any existing line_item. id of the group
- * to be deleted is required field in $params array
+ * This method is used to delete any existing LineItem given its id.
  *
  * @param array $params
- *   Array containing id of the group.
- *   to be deleted
+ *   Array containing id of the group to be deleted.
  *
  * @return array
  *   API result array