Merge pull request #4923 from colemanw/invoice_id

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

diff --git a/api/v3/File.php b/api/v3/File.php
index 2098de66f39f62eb9f598a7b04691b8e277134b5..f99dd393593d165abfed49a0eb87c9d5c30099bf 100644 (file)
--- a/api/v3/File.php
+++ b/api/v3/File.php
@@ -1,8 +1,7 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -45,10 +44,11 @@
  *
  * This API is used for creating a file
  *
- * @param   array  $params  an associative array of name/value property values of civicrm_file
+ * @param array $params
+ *   An associative array of name/value property values of civicrm_file.
  *
- * @return array of newly created file property values.
- * @access public
+ * @return array
+ *   Array of newly created file property values.
  */
 function civicrm_api3_file_create($params) {
 
@@ -81,10 +81,11 @@ function civicrm_api3_file_create($params) {
  * This api is used for finding an existing file.
  * Required parameters : id OR file_type_id of a file
  *
- * @param  array $params  an associative array of name/value property values of civicrm_file
+ * @param array $params
+ *   An associative array of name/value property values of civicrm_file.
  *
- * @return  Array of all found file object property values.
- * @access public
+ * @return array
+ *   Array of all found file object property values.
  */
 function civicrm_api3_file_get($params) {
   civicrm_api3_verify_one_mandatory($params);
@@ -97,10 +98,8 @@ function civicrm_api3_file_get($params) {
  * This api is used for updating an existing file.
  * Required parameters : id of a file
  *
- * @param  Array   $params an array of name/value property values of civicrm_file
- *
- * @return array of updated file object property values
- * @access public
+ * @param array $params
+ * @return array
  */
 function civicrm_api3_file_update($params) {
 
@@ -128,12 +127,10 @@ function civicrm_api3_file_update($params) {
  * This API is used for deleting a file
  * Required parameters : id of a file
  *
- * @param $params
- *
- * @internal param Int $fileId Id of the file to be deleted
+ * @param array $params
  *
- * @return null if successfull, object of CRM_Core_Error otherwise
- * @access public
+ * @return array
+ *   API result array
  */
 function civicrm_api3_file_delete($params) {