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/functions.php

    r5908 r5951  
    1616 * Output the bbPress version
    1717 *
    18  * @since bbPress (r3468)
     18 * @since 2.0.0 bbPress (r3468)
     19 *
    1920 * @uses bbp_get_version() To get the bbPress version
    2021 */
     
    2526     * Return the bbPress version
    2627     *
    27      * @since bbPress (r3468)
     28     * @since 2.0.0 bbPress (r3468)
     29     *
    2830     * @retrun string The bbPress version
    2931     */
     
    3537 * Output the bbPress database version
    3638 *
    37  * @since bbPress (r3468)
     39 * @since 2.0.0 bbPress (r3468)
     40 *
    3841 * @uses bbp_get_version() To get the bbPress version
    3942 */
     
    4447     * Return the bbPress database version
    4548     *
    46      * @since bbPress (r3468)
     49     * @since 2.0.0 bbPress (r3468)
     50     *
    4751     * @retrun string The bbPress version
    4852     */
     
    5458 * Output the bbPress database version directly from the database
    5559 *
    56  * @since bbPress (r3468)
     60 * @since 2.0.0 bbPress (r3468)
     61 *
    5762 * @uses bbp_get_version() To get the current bbPress version
    5863 */
     
    6368     * Return the bbPress database version directly from the database
    6469     *
    65      * @since bbPress (r3468)
     70     * @since 2.0.0 bbPress (r3468)
     71     *
    6672     * @retrun string The current bbPress version
    6773     */
     
    7581 * Update a posts' forum meta ID
    7682 *
    77  * @since bbPress (r3181)
     83 * @since 2.0.0 bbPress (r3181)
    7884 *
    7985 * @param int $post_id  The post to update
     
    94100 * Update a posts' topic meta ID
    95101 *
    96  * @since bbPress (r3181)
     102 * @since 2.0.0 bbPress (r3181)
    97103 *
    98104 * @param int $post_id  The post to update
     
    113119 * Update a posts' reply meta ID
    114120 *
    115  * @since bbPress (r3181)
     121 * @since 2.0.0 bbPress (r3181)
    116122 *
    117123 * @param int $post_id  The post to update
     
    132138 * Update a posts' reply-to meta ID
    133139 *
    134  * @since bbPress (r5735)
     140 * @since 2.6.0 bbPress (r5735)
    135141 *
    136142 * @param int $post_id  The post to update
     
    155161 * Does nothing much other than return the {@link $bbp->views} variable
    156162 *
    157  * @since bbPress (r2789)
     163 * @since 2.0.0 bbPress (r2789)
    158164 *
    159165 * @return array Views
     
    166172 * Register a bbPress view
    167173 *
    168  * @since bbPress (r2789)
     174 * @since 2.0.0 bbPress (r2789)
    169175 *
    170176 * @param string $view View name
     
    212218 * Deregister a bbPress view
    213219 *
    214  * @since bbPress (r2789)
     220 * @since 2.0.0 bbPress (r2789)
    215221 *
    216222 * @param string $view View name
     
    234240 * Run the view's query
    235241 *
    236  * @since bbPress (r2789)
     242 * @since 2.0.0 bbPress (r2789)
    237243 *
    238244 * @param string $view Optional. View id
     
    264270 * Return the view's query arguments
    265271 *
    266  * @since bbPress (r2789)
     272 * @since 2.0.0 bbPress (r2789)
    267273 *
    268274 * @param string $view View name
     
    284290 * Adds an error message to later be output in the theme
    285291 *
    286  * @since bbPress (r3381)
     292 * @since 2.0.0 bbPress (r3381)
    287293 *
    288294 * @see WP_Error()
     
    300306 * Check if error messages exist in queue
    301307 *
    302  * @since bbPress (r3381)
     308 * @since 2.0.0 bbPress (r3381)
    303309 *
    304310 * @see WP_Error()
     
    321327 * anywhere mentions might be used.
    322328 *
    323  * @since bbPress (r4997)
     329 * @since 2.4.0 bbPress (r4997)
     330 *
    324331 * @return string Pattern to match usernames with
    325332 */
     
    331338 * Searches through the content to locate usernames, designated by an @ sign.
    332339 *
    333  * @since bbPress (r4323)
     340 * @since 2.2.0 bbPress (r4323)
    334341 *
    335342 * @param string $content The content
     
    352359 * Finds and links @-mentioned users in the content
    353360 *
    354  * @since bbPress (r4323)
     361 * @since 2.2.0 bbPress (r4323)
    355362 *
    356363 * @uses bbp_find_mentions() To get usernames in content areas
     
    387394 * Return the public post status ID
    388395 *
    389  * @since bbPress (r3504)
     396 * @since 2.0.0 bbPress (r3504)
    390397 *
    391398 * @return string
     
    398405 * Return the pending post status ID
    399406 *
    400  * @since bbPress (r3581)
     407 * @since 2.1.0 bbPress (r3581)
    401408 *
    402409 * @return string
     
    409416 * Return the private post status ID
    410417 *
    411  * @since bbPress (r3504)
     418 * @since 2.0.0 bbPress (r3504)
    412419 *
    413420 * @return string
     
    420427 * Return the hidden post status ID
    421428 *
    422  * @since bbPress (r3504)
     429 * @since 2.0.0 bbPress (r3504)
    423430 *
    424431 * @return string
     
    431438 * Return the closed post status ID
    432439 *
    433  * @since bbPress (r3504)
     440 * @since 2.0.0 bbPress (r3504)
    434441 *
    435442 * @return string
     
    442449 * Return the spam post status ID
    443450 *
    444  * @since bbPress (r3504)
     451 * @since 2.0.0 bbPress (r3504)
    445452 *
    446453 * @return string
     
    453460 * Return the trash post status ID
    454461 *
    455  * @since bbPress (r3504)
     462 * @since 2.0.0 bbPress (r3504)
    456463 *
    457464 * @return string
     
    464471 * Return the orphan post status ID
    465472 *
    466  * @since bbPress (r3504)
     473 * @since 2.0.0 bbPress (r3504)
    467474 *
    468475 * @return string
     
    477484 * Return the unique ID for user profile rewrite rules
    478485 *
    479  * @since bbPress (r3762)
     486 * @since 2.1.0 bbPress (r3762)
     487 *
    480488 * @return string
    481489 */
     
    487495 * Return the unique ID for all edit rewrite rules (forum|topic|reply|tag|user)
    488496 *
    489  * @since bbPress (r3762)
     497 * @since 2.1.0 bbPress (r3762)
     498 *
    490499 * @return string
    491500 */
     
    497506 * Return the unique ID for all search rewrite rules
    498507 *
    499  * @since bbPress (r4579)
     508 * @since 2.3.0 bbPress (r4579)
    500509 *
    501510 * @return string
     
    508517 * Return the unique ID for user topics rewrite rules
    509518 *
    510  * @since bbPress (r4321)
     519 * @since 2.2.0 bbPress (r4321)
     520 *
    511521 * @return string
    512522 */
     
    518528 * Return the unique ID for user replies rewrite rules
    519529 *
    520  * @since bbPress (r4321)
     530 * @since 2.2.0 bbPress (r4321)
     531 *
    521532 * @return string
    522533 */
     
    528539 * Return the unique ID for user caps rewrite rules
    529540 *
    530  * @since bbPress (r4181)
     541 * @since 2.2.0 bbPress (r4181)
     542 *
    531543 * @return string
    532544 */
     
    538550 * Return the unique ID for user caps rewrite rules
    539551 *
    540  * @since bbPress (r4181)
     552 * @since 2.2.0 bbPress (r4181)
     553 *
    541554 * @return string
    542555 */
     
    548561 * Return the unique ID for topic view rewrite rules
    549562 *
    550  * @since bbPress (r3762)
     563 * @since 2.1.0 bbPress (r3762)
     564 *
    551565 * @return string
    552566 */
     
    560574 * Get the id used for paginated requests
    561575 *
    562  * @since bbPress (r4926)
     576 * @since 2.4.0 bbPress (r4926)
     577 *
    563578 * @return string
    564579 */
     
    571586 * the subsequent page load.
    572587 *
    573  * @since bbPress (r4198)
     588 * @since 2.2.0 bbPress (r4198)
    574589 */
    575590function bbp_delete_rewrite_rules() {
     
    582597 * Return true|false if this is a POST request
    583598 *
    584  * @since bbPress (r4790)
     599 * @since 2.3.0 bbPress (r4790)
     600 *
    585601 * @return bool
    586602 */
     
    592608 * Return true|false if this is a GET request
    593609 *
    594  * @since bbPress (r4790)
     610 * @since 2.3.0 bbPress (r4790)
     611 *
    595612 * @return bool
    596613 */
     
    609626 * in a future version, possibly to the site root.
    610627 *
    611  * @since bbPress (r5658)
     628 * @since 2.6.0 bbPress (r5658)
    612629 *
    613630 * @uses wp_safe_redirect()
Note: See TracChangeset for help on using the changeset viewer.