Api docblock cleanup.

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

diff --git a/api/v3/PrintLabel.php b/api/v3/PrintLabel.php
index f1016fc120f433577ddb2f23b507e115f56d1667..7090991ce38cda9e5e612f93c7d0a309fcbd72db 100644 (file)
--- a/api/v3/PrintLabel.php
+++ b/api/v3/PrintLabel.php
@@ -1,8 +1,7 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -24,59 +23,45 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
- * File for the CiviCRM APIv3 print_label functions
+ * This api exposes CiviCRM print_label.
  *
  * @package CiviCRM_APIv3
- * @subpackage API_print_label
- *
  */
 
 /**
- * Save a print_label
+ * Save a print_label.
  *
- * Allowed @params array keys are:
- * {@getfields print_label_create}
- * @example print_labelCreate.php
+ * @param array $params
  *
- * @param $params
- *
- * @return array of newly created print_label property values.
- * @access public
+ * @return array
+ *   Array of newly created print_label property values.
  */
 function civicrm_api3_print_label_create($params) {
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
 
 /**
- * Get a print_label
- *
- * Allowed @params array keys are:
- * {@getfields print_label_get}
- * @example print_labelCreate.php
+ * Get a print_label.
  *
- * @param $params
+ * @param array $params
  *
- * @return array of retrieved print_label property values.
- * @access public
+ * @return array
+ *   Array of retrieved print_label property values.
  */
 function civicrm_api3_print_label_get($params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
 
 /**
- * Delete a print_label
- *
- * Allowed @params array keys are:
- * {@getfields print_label_delete}
- * @example print_labelCreate.php
+ * Delete a print_label.
  *
- * @param $params
+ * @param array $params
  *
- * @return array of deleted values.
- * @access public
+ * @return array
+ *   Array of deleted values.
  */
 function civicrm_api3_print_label_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);