Skip to:
Content

bbPress.org


Ignore:
Timestamp:
10/28/2015 04:07:50 AM (10 years ago)
Author:
netweb
Message:

Standardize @since PHPDoc tags style and format

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:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/includes/core/options.php

    r5909 r5951  
    1616 * These option
    1717 *
    18  * @since bbPress (r3421)
     18 * @since 2.0.0 bbPress (r3421)
     19 *
    1920 * @return array Filtered option names and values
    2021 */
    … …  
    118119 * This is non-destructive, so existing settings will not be overridden.
    119120 *
    120  * @since bbPress (r3421)
     121 * @since 2.0.0 bbPress (r3421)
     122 *
    121123 * @uses bbp_get_default_options() To get default options
    122124 * @uses add_option() Adds default options
    … …  
    140142 * This is destructive, so existing settings will be destroyed.
    141143 *
    142  * @since bbPress (r3421)
     144 * @since 2.0.0 bbPress (r3421)
     145 *
    143146 * @uses bbp_get_default_options() To get default options
    144147 * @uses delete_option() Removes default options
    … …  
    160163 * inside the $bbp->options array.
    161164 *
    162  * @since bbPress (r3451)
     165 * @since 2.0.0 bbPress (r3451)
     166 *
    163167 * @uses bbp_get_default_options() To get default options
    164168 * @uses add_filter() To add filters to 'pre_option_{$key}'
    … …  
    180184 * $bbp->options array.
    181185 *
    182  * @since bbPress (r3451)
     186 * @since 2.0.0 bbPress (r3451)
     187 *
    183188 * @param bool $value Optional. Default value false
    184189 * @return mixed false if not overloaded, mixed if set
    … …  
    203208 * Checks if favorites feature is enabled.
    204209 *
    205  * @since bbPress (r2658)
     210 * @since 2.0.0 bbPress (r2658)
     211 *
    206212 * @param $default bool Optional.Default value true
    207213 * @uses get_option() To get the favorites option
    … …  
    215221 * Checks if subscription feature is enabled.
    216222 *
    217  * @since bbPress (r2658)
     223 * @since 2.0.0 bbPress (r2658)
     224 *
    218225 * @param $default bool Optional.Default value true
    219226 * @uses get_option() To get the subscriptions option
    … …  
    227234 * Are topic tags allowed
    228235 *
    229  * @since bbPress (r4097)
     236 * @since 2.2.0 bbPress (r4097)
     237 *
    230238 * @param $default bool Optional. Default value true
    231239 * @uses get_option() To get the allow tags
    … …  
    239247 * Are per-forum moderators allowed
    240248 *
    241  * @since bbPress (r5834)
     249 * @since 2.6.0 bbPress (r5834)
    242250 *
    243251 * @param bool $default Optional. Default value true.
    … …  
    253261 * Is forum-wide searching allowed
    254262 *
    255  * @since bbPress (r4970)
     263 * @since 2.4.0 bbPress (r4970)
     264 *
    256265 * @param $default bool Optional. Default value true
    257266 * @uses get_option() To get the forum-wide search setting
    … …  
    265274 * Are replies threaded
    266275 *
    267  * @since bbPress (r4944)
     276 * @since 2.4.0 bbPress (r4944)
    268277 *
    269278 * @param bool $default Optional. Default value true
    … …  
    284293 * Are threaded replies allowed
    285294 *
    286  * @since bbPress (r4964)
     295 * @since 2.4.0 bbPress (r4964)
     296 *
    287297 * @param $default bool Optional. Default value false
    288298 * @uses get_option() To get the threaded replies setting
    … …  
    296306 * Maximum reply thread depth
    297307 *
    298  * @since bbPress (r4944)
     308 * @since 2.4.0 bbPress (r4944)
    299309 *
    300310 * @param int $default Thread replies depth
    … …  
    311321 * Are topic and reply revisions allowed
    312322 *
    313  * @since bbPress (r3412)
     323 * @since 2.0.0 bbPress (r3412)
     324 *
    314325 * @param $default bool Optional. Default value true
    315326 * @uses get_option() To get the allow revisions
    … …  
    323334 * Is the anonymous posting allowed?
    324335 *
    325  * @since bbPress (r2659)
     336 * @since 2.0.0 bbPress (r2659)
     337 *
    326338 * @param $default bool Optional. Default value
    327339 * @uses get_option() To get the allow anonymous option
    … …  
    335347 * Is this forum available to all users on all sites in this installation?
    336348 *
    337  * @since bbPress (r3378)
     349 * @since 2.0.0 bbPress (r3378)
     350 *
    338351 * @param $default bool Optional. Default value false
    339352 * @uses get_option() To get the global access option
    … …  
    347360 * Is this forum available to all users on all sites in this installation?
    348361 *
    349  * @since bbPress (r4294)
     362 * @since 2.2.0 bbPress (r4294)
     363 *
    350364 * @param $default string Optional. Default value empty
    351365 * @uses get_option() To get the default forums role option
    … …  
    359373 * Use the WordPress editor if available
    360374 *
    361  * @since bbPress (r3386)
     375 * @since 2.0.0 bbPress (r3386)
     376 *
    362377 * @param $default bool Optional. Default value true
    363378 * @uses get_option() To get the WP editor option
    … …  
    371386 * Use WordPress's oEmbed API
    372387 *
    373  * @since bbPress (r3752)
     388 * @since 2.1.0 bbPress (r3752)
     389 *
    374390 * @param $default bool Optional. Default value true
    375391 * @uses get_option() To get the oEmbed option
    … …  
    383399 * Get the current theme package ID
    384400 *
    385  * @since bbPress (r3829)
     401 * @since 2.1.0 bbPress (r3829)
     402 *
    386403 * @param $default string Optional. Default value 'default'
    387404 * @uses get_option() To get the subtheme option
    … …  
    395412 * Output the maximum length of a title
    396413 *
    397  * @since bbPress (r3246)
     414 * @since 2.0.0 bbPress (r3246)
     415 *
    398416 * @param $default bool Optional. Default value 80
    399417 */
    … …  
    404422     * Return the maximum length of a title
    405423     *
    406      * @since bbPress (r3246)
     424     * @since 2.0.0 bbPress (r3246)
     425     *
    407426     * @param $default bool Optional. Default value 80
    408427     * @uses get_option() To get the maximum title length
    … …  
    416435 * Output the grop forums root parent forum id
    417436 *
    418  * @since bbPress (r3575)
     437 * @since 2.1.0 bbPress (r3575)
     438 *
    419439 * @param $default int Optional. Default value
    420440 */
    … …  
    425445     * Return the grop forums root parent forum id
    426446     *
    427      * @since bbPress (r3575)
     447     * @since 2.1.0 bbPress (r3575)
     448     *
    428449     * @param $default bool Optional. Default value 0
    429450     * @uses get_option() To get the root group forum ID
    … …  
    437458 * Checks if BuddyPress Group Forums are enabled
    438459 *
    439  * @since bbPress (r3575)
     460 * @since 2.1.0 bbPress (r3575)
     461 *
    440462 * @param $default bool Optional. Default value true
    441463 * @uses get_option() To get the group forums option
    … …  
    449471 * Checks if Akismet is enabled
    450472 *
    451  * @since bbPress (r3575)
     473 * @since 2.1.0 bbPress (r3575)
     474 *
    452475 * @param $default bool Optional. Default value true
    453476 * @uses get_option() To get the Akismet option
    … …  
    461484 * Integrate settings into existing WordPress pages
    462485 *
    463  * @since bbPress (r4932)
     486 * @since 2.4.0 bbPress (r4932)
     487 *
    464488 * @param $default bool Optional. Default value false
    465489 * @uses get_option() To get the admin integration setting
    … …  
    475499 * Return the root slug
    476500 *
    477  * @since bbPress (r3759)
     501 * @since 2.1.0 bbPress (r3759)
     502 *
    478503 * @return string
    479504 */
    … …  
    485510 * Are we including the root slug in front of forum pages?
    486511 *
    487  * @since bbPress (r3759)
     512 * @since 2.1.0 bbPress (r3759)
     513 *
    488514 * @return bool
    489515 */
    … …  
    495521 * Return the search slug
    496522 *
    497  * @since bbPress (r4932)
     523 * @since 2.4.0 bbPress (r4932)
    498524 *
    499525 * @return string
    … …  
    506532 * Maybe return the root slug, based on whether or not it's included in the url
    507533 *
    508  * @since bbPress (r3759)
     534 * @since 2.1.0 bbPress (r3759)
     535 *
    509536 * @return string
    510537 */
    … …  
    522549 * Return the single forum slug
    523550 *
    524  * @since bbPress (r3759)
     551 * @since 2.1.0 bbPress (r3759)
     552 *
    525553 * @return string
    526554 */
    … …  
    532560 * Return the topic archive slug
    533561 *
    534  * @since bbPress (r3759)
     562 * @since 2.1.0 bbPress (r3759)
     563 *
    535564 * @return string
    536565 */
    … …  
    542571 * Return the reply archive slug
    543572 *
    544  * @since bbPress (r4925)
     573 * @since 2.4.0 bbPress (r4925)
     574 *
    545575 * @return string
    546576 */
    … …  
    552582 * Return the single topic slug
    553583 *
    554  * @since bbPress (r3759)
     584 * @since 2.1.0 bbPress (r3759)
     585 *
    555586 * @return string
    556587 */
    … …  
    562593 * Return the topic-tag taxonomy slug
    563594 *
    564  * @since bbPress (r3759)
     595 * @since 2.1.0 bbPress (r3759)
     596 *
    565597 * @return string
    566598 */
    … …  
    572604 * Return the single reply slug (used mostly for editing)
    573605 *
    574  * @since bbPress (r3759)
     606 * @since 2.1.0 bbPress (r3759)
     607 *
    575608 * @return string
    576609 */
    … …  
    582615 * Return the single user slug
    583616 *
    584  * @since bbPress (r3759)
     617 * @since 2.1.0 bbPress (r3759)
     618 *
    585619 * @return string
    586620 */
    … …  
    592626 * Return the single user favorites slug
    593627 *
    594  * @since bbPress (r4187)
     628 * @since 2.2.0 bbPress (r4187)
     629 *
    595630 * @return string
    596631 */
    … …  
    602637 * Return the single user subscriptions slug
    603638 *
    604  * @since bbPress (r4187)
     639 * @since 2.2.0 bbPress (r4187)
     640 *
    605641 * @return string
    606642 */
    … …  
    612648 * Return the topic view slug
    613649 *
    614  * @since bbPress (r3759)
     650 * @since 2.1.0 bbPress (r3759)
     651 *
    615652 * @return string
    616653 */
    … …  
    622659 * Return the search slug
    623660 *
    624  * @since bbPress (r4579)
     661 * @since 2.3.0 bbPress (r4579)
    625662 *
    626663 * @return string
    … …  
    635672 * Checks if there is a previous BuddyPress Forum configuration
    636673 *
    637  * @since bbPress (r3790)
     674 * @since 2.1.0 bbPress (r3790)
     675 *
    638676 * @param $default string Optional. Default empty string
    639677 * @uses get_option() To get the old bb-config.php location
Note: See TracChangeset for help on using the changeset viewer.