Merge pull request #6378 from johanv/CRM-15991-permission_delete_relationship

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

diff --git a/api/v3/LineItem.php b/api/v3/LineItem.php
index c44c4e1ab5572fa7e5943a79d89f70774013b649..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,11 +27,11 @@
 
 
 /**
- * File for the CiviCRM APIv3 line item 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
  */
 
 /**
@@ -54,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;
@@ -79,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