Changeset 5951 for trunk/src/includes/admin/settings.php

Timestamp:

10/28/2015 04:07:50 AM (10 years ago)

Author:

netweb

Message:

Standardize @since PHPDoc tags style and format

• e.g. @since 2.6.0 bbPress (r5951) YOLO
• See ​http://phpdoc.org/docs/latest/references/phpdoc/tags/since.html

This changeset updates the style and formatting of all of our @since instances for compatibility with phpDocumentor 2 and WP-Parser as we move toward implementing the bbPress developer code reference.

Props thebrandonallen
Fixes #2879

File:

• trunk/src/includes/admin/settings.php (modified) (68 diffs)

trunk/src/includes/admin/settings.php

@@ -16 +16 @@
  * Get the Forums settings sections.
  *
- * @since bbPress (r4001)
+ * @since 2.1.0 bbPress (r4001)
+ *
  * @return array
  */
@@ -77 +78 @@
  * Get all of the settings fields.
  *
- * @since bbPress (r4001)
+ * @since 2.1.0 bbPress (r4001)
+ *
  * @return type
  */
@@ -430 +432 @@
  * Get settings fields by section.
  *
- * @since bbPress (r4001)
+ * @since 2.1.0 bbPress (r4001)
+ *
  * @param string $section_id
  * @return mixed False if section is invalid, array of fields otherwise.
@@ -454 +457 @@
  * User settings section description for the settings page
  *
- * @since bbPress (r2786)
+ * @since 2.0.0 bbPress (r2786)
  */
 function bbp_admin_setting_callback_user_section() {
@@ -468 +471 @@
  * Edit lock setting field
  *
- * @since bbPress (r2737)
+ * @since 2.0.0 bbPress (r2737)
  *
  * @uses bbp_form_option() To output the option value
@@ -484 +487 @@
  * Throttle setting field
  *
- * @since bbPress (r2737)
+ * @since 2.0.0 bbPress (r2737)
  *
  * @uses bbp_form_option() To output the option value
@@ -500 +503 @@
  * Allow anonymous posting setting field
  *
- * @since bbPress (r2737)
+ * @since 2.0.0 bbPress (r2737)
  *
  * @uses checked() To display the checked attribute
@@ -516 +519 @@
  * Allow global access setting field
  *
- * @since bbPress (r3378)
+ * @since 2.0.0 bbPress (r3378)
  *
  * @uses checked() To display the checked attribute
@@ -553 +556 @@
  * Features settings section description for the settings page
  *
- * @since bbPress (r2786)
+ * @since 2.0.0 bbPress (r2786)
  */
 function bbp_admin_setting_callback_features_section() {
@@ -566 +569 @@
  * Allow favorites setting field
  *
- * @since bbPress (r2786)
+ * @since 2.0.0 bbPress (r2786)
  *
  * @uses checked() To display the checked attribute
@@ -582 +585 @@
  * Allow subscriptions setting field
  *
- * @since bbPress (r2737)
+ * @since 2.0.0 bbPress (r2737)
  *
  * @uses checked() To display the checked attribute
@@ -598 +601 @@
  * Allow topic tags setting field
  *
- * @since bbPress (r4944)
+ * @since 2.4.0 bbPress (r4944)
  *
  * @uses checked() To display the checked attribute
@@ -614 +617 @@
  * Allow forum-mods setting field
  *
- * @since bbPress (r5834)
+ * @since 2.6.0 bbPress (r5834)
  *
  * @uses checked() To display the checked attribute
@@ -630 +633 @@
  * Allow forum wide search
  *
- * @since bbPress (r4970)
+ * @since 2.4.0 bbPress (r4970)
  *
  * @uses checked() To display the checked attribute
@@ -648 +651 @@
  * Replies will be threaded if depth is 2 or greater
  *
- * @since bbPress (r4944)
+ * @since 2.4.0 bbPress (r4944)
  *
  * @uses apply_filters() Calls 'bbp_thread_replies_depth_max' to set a
@@ -686 +689 @@
  * Allow topic and reply revisions
  *
- * @since bbPress (r3412)
+ * @since 2.0.0 bbPress (r3412)
  *
  * @uses checked() To display the checked attribute
@@ -702 +705 @@
  * Use the WordPress editor setting field
  *
- * @since bbPress (r3586)
+ * @since 2.1.0 bbPress (r3586)
  *
  * @uses checked() To display the checked attribute
@@ -718 +721 @@
  * Main subtheme section
  *
- * @since bbPress (r2786)
+ * @since 2.0.0 bbPress (r2786)
  */
 function bbp_admin_setting_callback_subtheme_section() {
@@ -731 +734 @@
  * Use the WordPress editor setting field
  *
- * @since bbPress (r3586)
+ * @since 2.1.0 bbPress (r3586)
  *
  * @uses checked() To display the checked attribute
@@ -765 +768 @@
  * Allow oEmbed in replies
  *
- * @since bbPress (r3752)
+ * @since 2.1.0 bbPress (r3752)
  *
  * @uses checked() To display the checked attribute
@@ -783 +786 @@
  * Per page settings section description for the settings page
  *
- * @since bbPress (r2786)
+ * @since 2.0.0 bbPress (r2786)
  */
 function bbp_admin_setting_callback_per_page_section() {
@@ -796 +799 @@
  * Topics per page setting field
  *
- * @since bbPress (r2786)
+ * @since 2.0.0 bbPress (r2786)
  *
  * @uses bbp_form_option() To output the option value
@@ -812 +815 @@
  * Replies per page setting field
  *
- * @since bbPress (r2786)
+ * @since 2.0.0 bbPress (r2786)
  *
  * @uses bbp_form_option() To output the option value
@@ -830 +833 @@
  * Per page settings section description for the settings page
  *
- * @since bbPress (r2786)
+ * @since 2.0.0 bbPress (r2786)
  */
 function bbp_admin_setting_callback_per_rss_page_section() {
@@ -843 +846 @@
  * Topics per RSS page setting field
  *
- * @since bbPress (r2786)
+ * @since 2.0.0 bbPress (r2786)
  *
  * @uses bbp_form_option() To output the option value
@@ -859 +862 @@
  * Replies per RSS page setting field
  *
- * @since bbPress (r2786)
+ * @since 2.0.0 bbPress (r2786)
  *
  * @uses bbp_form_option() To output the option value
@@ -877 +880 @@
  * Slugs settings section description for the settings page
  *
- * @since bbPress (r2786)
+ * @since 2.0.0 bbPress (r2786)
  */
 function bbp_admin_setting_callback_root_slug_section() {
@@ -894 +897 @@
  * Root slug setting field
  *
- * @since bbPress (r2786)
+ * @since 2.0.0 bbPress (r2786)
  *
  * @uses bbp_form_option() To output the option value
@@ -911 +914 @@
  * Include root slug setting field
  *
- * @since bbPress (r2786)
+ * @since 2.0.0 bbPress (r2786)
  *
  * @uses checked() To display the checked attribute
@@ -927 +930 @@
  * Include root slug setting field
  *
- * @since bbPress (r2786)
+ * @since 2.0.0 bbPress (r2786)
  *
  * @uses checked() To display the checked attribute
@@ -964 +967 @@
  * Slugs settings section description for the settings page
  *
- * @since bbPress (r2786)
+ * @since 2.0.0 bbPress (r2786)
  */
 function bbp_admin_setting_callback_user_slug_section() {
@@ -977 +980 @@
  * User slug setting field
  *
- * @since bbPress (r2786)
+ * @since 2.0.0 bbPress (r2786)
  *
  * @uses bbp_form_option() To output the option value
@@ -994 +997 @@
  * Topic archive slug setting field
  *
- * @since bbPress (r2786)
+ * @since 2.0.0 bbPress (r2786)
  *
  * @uses bbp_form_option() To output the option value
@@ -1011 +1014 @@
  * Reply archive slug setting field
  *
- * @since bbPress (r4932)
+ * @since 2.4.0 bbPress (r4932)
  *
  * @uses bbp_form_option() To output the option value
@@ -1028 +1031 @@
  * Favorites slug setting field
  *
- * @since bbPress (r4932)
+ * @since 2.4.0 bbPress (r4932)
  *
  * @uses bbp_form_option() To output the option value
@@ -1045 +1048 @@
  * Favorites slug setting field
  *
- * @since bbPress (r4932)
+ * @since 2.4.0 bbPress (r4932)
  *
  * @uses bbp_form_option() To output the option value
@@ -1064 +1067 @@
  * Slugs settings section description for the settings page
  *
- * @since bbPress (r2786)
+ * @since 2.0.0 bbPress (r2786)
  */
 function bbp_admin_setting_callback_single_slug_section() {
@@ -1077 +1080 @@
  * Forum slug setting field
  *
- * @since bbPress (r2786)
+ * @since 2.0.0 bbPress (r2786)
  *
  * @uses bbp_form_option() To output the option value
@@ -1094 +1097 @@
  * Topic slug setting field
  *
- * @since bbPress (r2786)
+ * @since 2.0.0 bbPress (r2786)
  *
  * @uses bbp_form_option() To output the option value
@@ -1111 +1114 @@
  * Reply slug setting field
  *
- * @since bbPress (r2786)
+ * @since 2.0.0 bbPress (r2786)
  *
  * @uses bbp_form_option() To output the option value
@@ -1128 +1131 @@
  * Topic tag slug setting field
  *
- * @since bbPress (r2786)
+ * @since 2.0.0 bbPress (r2786)
  *
  * @uses bbp_form_option() To output the option value
@@ -1146 +1149 @@
  * View slug setting field
  *
- * @since bbPress (r2789)
+ * @since 2.0.0 bbPress (r2789)
  *
  * @uses bbp_form_option() To output the option value
@@ -1163 +1166 @@
  * Search slug setting field
  *
- * @since bbPress (r4579)
+ * @since 2.3.0 bbPress (r4579)
  *
  * @uses bbp_form_option() To output the option value
@@ -1182 +1185 @@
  * Extension settings section description for the settings page
  *
- * @since bbPress (r3575)
+ * @since 2.1.0 bbPress (r3575)
  */
 function bbp_admin_setting_callback_buddypress_section() {
@@ -1195 +1198 @@
  * Allow BuddyPress group forums setting field
  *
- * @since bbPress (r3575)
+ * @since 2.1.0 bbPress (r3575)
  *
  * @uses checked() To display the checked attribute
@@ -1211 +1214 @@
  * Replies per page setting field
  *
- * @since bbPress (r3575)
+ * @since 2.1.0 bbPress (r3575)
  *
  * @uses bbp_form_option() To output the option value
@@ -1239 +1242 @@
  * Extension settings section description for the settings page
  *
- * @since bbPress (r3575)
+ * @since 2.1.0 bbPress (r3575)
  */
 function bbp_admin_setting_callback_akismet_section() {
@@ -1253 +1256 @@
  * Allow Akismet setting field
  *
- * @since bbPress (r3575)
+ * @since 2.1.0 bbPress (r3575)
  *
  * @uses checked() To display the checked attribute
@@ -1271 +1274 @@
  * The main settings page
  *
- * @since bbPress (r2643)
+ * @since 2.0.0 bbPress (r2643)
  *
  * @uses settings_fields() To output the hidden fields for the form
@@ -1304 +1307 @@
  * Main settings section description for the settings page
  *
- * @since bbPress (r3813)
+ * @since 2.1.0 bbPress (r3813)
  */
 function bbp_converter_setting_callback_main_section() {
@@ -1317 +1320 @@
  * Edit Platform setting field
  *
- * @since bbPress (r3813)
+ * @since 2.1.0 bbPress (r3813)
  */
 function bbp_converter_setting_callback_platform() {
@@ -1348 +1351 @@
  * Edit Database Server setting field
  *
- * @since bbPress (r3813)
+ * @since 2.1.0 bbPress (r3813)
  */
 function bbp_converter_setting_callback_dbserver() {
@@ -1362 +1365 @@
  * Edit Database Server Port setting field
  *
- * @since bbPress (r3813)
+ * @since 2.1.0 bbPress (r3813)
  */
 function bbp_converter_setting_callback_dbport() {
@@ -1376 +1379 @@
  * Edit Database User setting field
  *
- * @since bbPress (r3813)
+ * @since 2.1.0 bbPress (r3813)
  */
 function bbp_converter_setting_callback_dbuser() {
@@ -1390 +1393 @@
  * Edit Database Pass setting field
  *
- * @since bbPress (r3813)
+ * @since 2.1.0 bbPress (r3813)
  */
 function bbp_converter_setting_callback_dbpass() {
@@ -1404 +1407 @@
  * Edit Database Name setting field
  *
- * @since bbPress (r3813)
+ * @since 2.1.0 bbPress (r3813)
  */
 function bbp_converter_setting_callback_dbname() {
@@ -1418 +1421 @@
  * Main settings section description for the settings page
  *
- * @since bbPress (r3813)
+ * @since 2.1.0 bbPress (r3813)
  */
 function bbp_converter_setting_callback_options_section() {
@@ -1431 +1434 @@
  * Edit Table Prefix setting field
  *
- * @since bbPress (r3813)
+ * @since 2.1.0 bbPress (r3813)
  */
 function bbp_converter_setting_callback_dbprefix() {
@@ -1445 +1448 @@
  * Edit Rows Limit setting field
  *
- * @since bbPress (r3813)
+ * @since 2.1.0 bbPress (r3813)
  */
 function bbp_converter_setting_callback_rows() {
@@ -1460 +1463 @@
  * Edit Delay Time setting field
  *
- * @since bbPress (r3813)
+ * @since 2.1.0 bbPress (r3813)
  */
 function bbp_converter_setting_callback_delay_time() {
@@ -1475 +1478 @@
  * Edit Restart setting field
  *
- * @since bbPress (r3813)
+ * @since 2.1.0 bbPress (r3813)
  */
 function bbp_converter_setting_callback_restart() {
@@ -1490 +1493 @@
  * Edit Clean setting field
  *
- * @since bbPress (r3813)
+ * @since 2.1.0 bbPress (r3813)
  */
 function bbp_converter_setting_callback_clean() {
@@ -1505 +1508 @@
  * Edit Convert Users setting field
  *
- * @since bbPress (r3813)
+ * @since 2.1.0 bbPress (r3813)
  */
 function bbp_converter_setting_callback_convert_users() {
@@ -1556 +1559 @@
  * Contextual help for Forums settings page
  *
- * @since bbPress (r3119)
+ * @since 2.0.0 bbPress (r3119)
+ *
  * @uses get_current_screen()
  */
@@ -1627 +1631 @@
  * options array.
  *
- * @since bbPress (r4347)
+ * @since 2.2.0 bbPress (r4347)
  *
  * @param string $option_key
@@ -1638 +1642 @@
  * Output settings API option
  *
- * @since bbPress (r3203)
+ * @since 2.0.0 bbPress (r3203)
  *
  * @uses bbp_get_bbp_form_option()
@@ -1652 +1656 @@
      * Return settings API option
      *
-     * @since bbPress (r3203)
+     * @since 2.0.0 bbPress (r3203)
      *
      * @uses get_option()
@@ -1688 +1692 @@
  * Used to check if a bbPress slug conflicts with an existing known slug.
  *
- * @since bbPress (r3306)
+ * @since 2.0.0 bbPress (r3306)
  *
  * @param string $slug