Merge pull request #5049 from totten/master-mailing-multiling

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

diff --git a/api/v3/Note.php b/api/v3/Note.php
index 82542c550fd7ccfc1ba965fc21fef24f13632d1d..86fe2ee0bc244c1916dac1197e93270c173ca600 100644 (file)
--- a/api/v3/Note.php
+++ b/api/v3/Note.php
@@ -26,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
@@ -54,9 +51,10 @@ function civicrm_api3_note_create($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.
  */
@@ -68,15 +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
+ * @return array
  */
 function civicrm_api3_note_delete($params) {
 
@@ -85,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.
@@ -93,7 +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}
  */
 function civicrm_api3_note_get($params) {
 
@@ -101,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.
  */
@@ -112,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.