X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=api%2Fv3%2FNote.php;h=86fe2ee0bc244c1916dac1197e93270c173ca600;hb=d5b9585b3da73a76dada27cfa2f791c6c4763cd5;hp=84ae06c90fbd969e1916e8b2b148c473c7f4a855;hpb=5f53b1c171d164470d6bbf6002841cdd17c55912;p=civicrm-core.git

diff --git a/api/v3/Note.php b/api/v3/Note.php
index 84ae06c90f..86fe2ee0bc 100644
--- a/api/v3/Note.php
+++ b/api/v3/Note.php
@@ -1,5 +1,4 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
@@ -27,18 +26,15 @@
  */
 
 /**
- * File for the CiviCRM APIv3 note functions
+ * This api exposes CiviCRM note.
  *
  * @package CiviCRM_APIv3
  * @subpackage API_Note
  *
- * @copyright CiviCRM LLC (c) 2004-2014
- * @version $Id: Note.php 30879 2010-11-22 15:45:55Z shot $
- *
  */
 
 /**
- * Create Note
+ * Create Note.
  *
  * This API is used for creating a note.
  * Required parameters : entity_id AND note
@@ -49,19 +45,16 @@
  *
  * @return array
  *   API result array
- * @access public
- * @example NoteCreate.php Create example
- *
- *
  */
 function civicrm_api3_note_create($params) {
   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.
  */
@@ -73,16 +66,14 @@ function _civicrm_api3_note_create_spec(&$params) {
 }
 
 /**
- * Deletes an existing note
+ * Deletes an existing note.
  *
  * This API is used for deleting a note
  *
  * @param array $params
  *   Including id of the note to be deleted.
- * {@getfields note_delete}
  *
- * @return null
- * @access public
+ * @return array
  */
 function civicrm_api3_note_delete($params) {
 
@@ -91,7 +82,7 @@ function civicrm_api3_note_delete($params) {
 }
 
 /**
- * Retrieve a specific note, given a set of input params
+ * Retrieve a specific note or notes, given a set of input params.
  *
  * @param array $params
  *   Input parameters.
@@ -99,9 +90,6 @@ function civicrm_api3_note_delete($params) {
  * @return array
  *   array of properties,
  *   if error an array with an error id and error message
- * {@getfields note_get}
- * @static
- * @access public
  */
 function civicrm_api3_note_get($params) {
 
@@ -109,9 +97,10 @@ function civicrm_api3_note_get($params) {
 }
 
 /**
- * Adjust Metadata for Get action
+ * Adjust Metadata for Get 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.
  */
@@ -120,10 +109,10 @@ function _civicrm_api3_note_get_spec(&$params) {
 }
 
 /**
- * Get all descendents of given note
+ * Get all descendants of given note.
  *
  * @param array $params
- *   Associative array; only required 'id' parameter is used.
+ *   array; only required 'id' parameter is used.
  *
  * @return array
  *   Nested associative array beginning with direct children of given note.