Merge pull request #6251 from LevityNL/master
[civicrm-core.git] / api / v3 / LineItem.php
index d5ca8d62c7b3e470a8dbaaff5164828c0e52e5bc..9a025c7fcacfb43891fcebce8c56af00a285b13d 100644 (file)
@@ -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,7 +27,9 @@
 
 
 /**
- * This api exposes CiviCRM line item.
+ * This api exposes CiviCRM LineItem records.
+ *
+ * Line items are sub-components of a complete financial transaction record.
  *
  * @package CiviCRM_APIv3
  */
@@ -77,10 +79,9 @@ 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.