Changeset 10825 for trunk/src/bp-core/admin/bp-core-admin-settings.php

Timestamp:

05/29/2016 06:12:08 PM (9 years ago)

Author:

djpaul

Message:

Remove redundant @uses PHPDoc tag from inline documentation.

Per WordPress' inline documentation standards, the @uses tag is not recommended to be used to indicate a used-by relationship, as this information can be derived through other means. These tags also are very likely to become out-of-date as our functions change over time.

File:

• trunk/src/bp-core/admin/bp-core-admin-settings.php (modified) (10 diffs)

trunk/src/bp-core/admin/bp-core-admin-settings.php

@@ -23 +23 @@
  * @since 1.6.0
  *
- * @uses bp_form_option() To output the option value.
  */
 function bp_admin_setting_callback_admin_bar() {
@@ -39 +38 @@
  * @since 1.6.0
  *
- * @uses checked() To display the checked attribute.
  */
 function bp_admin_setting_callback_account_deletion() {
@@ -64 +62 @@
  * @since 1.6.0
  *
- * @uses checked() To display the checked attribute.
  */
 function bp_admin_setting_callback_activity_akismet() {
@@ -133 +130 @@
  * @since 1.6.0
  *
- * @uses bp_form_option() To output the option value.
  */
 function bp_admin_setting_callback_profile_sync() {
@@ -149 +145 @@
  * @since 1.6.0
  *
- * @uses checked() To display the checked attribute.
  */
 function bp_admin_setting_callback_avatar_uploads() {
@@ -186 +181 @@
  * @since 1.6.0
  *
- * @uses checked() To display the checked attribute.
  */
 function bp_admin_setting_callback_group_creation() {
@@ -236 +230 @@
  * @since 1.6.0
  *
- * @uses checked() To display the checked attribute.
- * @uses bp_get_option() To get the config location.
- * @uses bp_form_option() To get the sanitized form option.
  */
 function bp_admin_setting_callback_bbpress_configuration() {
@@ -266 +257 @@
  * @since 1.6.0
  *
- * @uses settings_fields() To output the hidden fields for the form.
- * @uses do_settings_sections() To output the settings sections.
  */
 function bp_core_admin_settings() {
@@ -351 +340 @@
  * @since 1.6.0
  *
- * @uses bp_get_bp_form_option()
- *
  * @param string $option  Form option to echo.
  * @param string $default Form option default.
@@ -365 +352 @@
      * @since 1.6.0
      *
-     * @uses bp_get_option()
-     * @uses esc_attr()
-     * @uses apply_filters()
      *
      * @param string $option  Form option to return.