X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=api%2Fv3%2FLocBlock.php;h=f360e598dc4eb568a3fa7ce4c98ff301030bec79;hb=8319cf114f26e04bb7586cd253af9d97b8cb3859;hp=cb29a2050eb064c9b75631c310232295ff84ceb3;hpb=e3a363809875b227257e2247d43ed96115817c65;p=civicrm-core.git

diff --git a/api/v3/LocBlock.php b/api/v3/LocBlock.php
index cb29a2050e..f360e598dc 100644
--- a/api/v3/LocBlock.php
+++ b/api/v3/LocBlock.php
@@ -1,8 +1,7 @@
 <?php
-/*
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -24,7 +23,7 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 
 /**
@@ -38,13 +37,14 @@
 /**
  * Create or update a loc_block
  *
- * @param array $params  Associative array of property
+ * @param array $params
+ *   Associative array of property.
  *                       name/value pairs to insert in new 'loc_block'
  * @example LocBlockCreate.php Std Create example
  *
- * @return array api result array
- * {@getfields loc_block_create}
- * @access public
+ * @return array
+ *   api result array
+ *   {@getfields loc_block_create}
  */
 function civicrm_api3_loc_block_create($params) {
   $entities = array();
@@ -89,12 +89,13 @@ function civicrm_api3_loc_block_create($params) {
 /**
  * Returns array of loc_blocks matching a set of one or more properties
  *
- * @param array $params Array of one or more valid property_name=>value pairs. If $params is set
- *  as null, all loc_blocks will be returned (default limit is 25)
+ * @param array $params
+ *   Array of one or more valid property_name=>value pairs. If $params is set.
+ *   as null, all loc_blocks will be returned (default limit is 25)
  *
- * @return array  Array of matching loc_blocks
- * {@getfields loc_block_get}
- * @access public
+ * @return array
+ *   Array of matching loc_blocks
+ *   {@getfields loc_block_get}
  */
 function civicrm_api3_loc_block_get($params) {
   $options = _civicrm_api3_get_options_from_params($params);
@@ -127,11 +128,12 @@ function civicrm_api3_loc_block_get($params) {
  * This method is used to delete any existing loc_block.
  * id of the record to be deleted is required field in $params array
  *
- * @param array $params array containing id of the record to be deleted
+ * @param array $params
+ *   Array containing id of the record to be deleted.
  *
- * @return array  returns flag true if successfull, error message otherwise
- * {@getfields loc_block_delete}
- * @access public
+ * @return array
+ *   API result array
+ *   {@getfields loc_block_delete}
  */
 function civicrm_api3_loc_block_delete($params) {
   return _civicrm_api3_basic_delete('CRM_Core_DAO_LocBlock', $params);