Merge pull request #5097 from PalanteJon/CRM-15917

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

diff --git a/api/v3/Extension.php b/api/v3/Extension.php
index 7ca3d97a0db32b38f91d498ec7391b2d7c391f68..2dfbe7728aa3b99e67ea6b1013f84ac4e241cd3a 100644 (file)
--- a/api/v3/Extension.php
+++ b/api/v3/Extension.php
@@ -29,24 +29,19 @@ define('API_V3_EXTENSION_DELIMITER', ',');
 
 
 /**
- * File for the CiviCRM APIv3 extension functions
+ * This api exposes CiviCRM extension.
  *
  * @package CiviCRM_APIv3
- * @subpackage API_Extension
- *
- * @copyright CiviCRM LLC (c) 2004-2014
- * @version $Id$
- *
  */
 
 /**
- * Install an extension
+ * Install an extension.
  *
  * @param array $params
  *   Input parameters.
- *                          - key: string, eg "com.example.myextension"
- *                          - keys: mixed; array of string, eg array("com.example.myextension1", "com.example.myextension2") or string with comma-delimited list
- *                            using 'keys' should be more performant than making multiple API calls with 'key'
+ *   - key: string, eg "com.example.myextension"
+ *   - keys: mixed; array of string, eg array("com.example.myextension1", "com.example.myextension2") or string with comma-delimited list
+ *   Using 'keys' should be more performant than making multiple API calls with 'key'.
  *
  * @return array
  *   API result
@@ -98,7 +93,7 @@ function civicrm_api3_extension_upgrade() {
 }
 
 /**
- * Enable an extension
+ * Enable an extension.
  *
  * @param array $params
  *   Input parameters.
@@ -142,7 +137,7 @@ function civicrm_api3_extension_disable($params) {
 }
 
 /**
- * Uninstall an extension,
+ * Uninstall an extension.
  *
  * @param array $params
  *   Input parameters.
@@ -166,7 +161,7 @@ function civicrm_api3_extension_uninstall($params) {
 }
 
 /**
- * Download and install an extension
+ * Download and install an extension.
  *
  * @param array $params
  *   Input parameters.
@@ -176,7 +171,6 @@ function civicrm_api3_extension_uninstall($params) {
  * @throws API_Exception
  * @return array
  *   API result
- * @example ExtensionDownload.php
  */
 function civicrm_api3_extension_download($params) {
   if (!array_key_exists('key', $params)) {
@@ -217,7 +211,7 @@ function civicrm_api3_extension_download($params) {
 }
 
 /**
- * Download and install an extension
+ * Download and install an extension.
  *
  * @param array $params
  *   Input parameters.
@@ -226,8 +220,6 @@ function civicrm_api3_extension_download($params) {
  *
  * @return array
  *   API result
- * @example ExtensionRefresh.php
- *
  */
 function civicrm_api3_extension_refresh($params) {
   $defaults = array('local' => TRUE, 'remote' => TRUE);