CRM-15578 - Mailing.create API - Set defaults that match UX

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

diff --git a/api/v3/Website.php b/api/v3/Website.php
index c8df00738f8beb65ad368bbb2eeaeb88b3153834..8ce2cfc0b2b7826c003b31499ce38000dde36c1a 100644 (file)
--- a/api/v3/Website.php
+++ b/api/v3/Website.php
@@ -23,30 +23,21 @@
  | 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 website functions
+ * This api exposes CiviCRM website records.
  *
  * @package CiviCRM_APIv3
- * @subpackage API_Website
- *
- * @copyright CiviCRM LLC (c) 2004-2014
- * @version $Id: Website.php 2011-03-16 ErikHommel $
  */
 
 /**
- *  Add an Website for a contact
- *
- * Allowed @params array keys are:
- * {@getfields website_create}
- * @example WebsiteCreate.php
- * {@example WebsiteCreate.php}
+ * Add an Website for a contact.
  *
  * @param array $params
  *
  * @return array
- *   Array of newly created website property values.
+ *   API result array.
  * @todo convert to using basic create - BAO function non-std
  */
 function civicrm_api3_website_create($params) {
@@ -59,21 +50,24 @@ function civicrm_api3_website_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.
+ *   Array of parameters determined by getfields.
  */
 function _civicrm_api3_website_create_spec(&$params) {
   $params['contact_id']['api.required'] = 1;
 }
 
 /**
- * Deletes an existing Website
+ * Deletes an existing Website.
+ *
  * @todo convert to using Basic delete - BAO function non standard
+ *
  * @param array $params
- * {@getfields website_delete}
+ *
  * @return array
  *   API result
  * @throws \API_Exception
@@ -96,18 +90,12 @@ function civicrm_api3_website_delete($params) {
 }
 
 /**
- * Retrieve one or more websites
+ * Retrieve one or more websites.
  *
- * @param mixed[] (reference ) input parameters
- * {@getfields website_get}
- * {@example WebsiteGet.php 0}
- * @example WebsiteGet.php
  * @param array $params
- *   An associative array of name/value pairs.
  *
  * @return array
  *   details of found websites
- *
  */
 function civicrm_api3_website_get($params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, TRUE, 'website');