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/users/template.php

    r5900 r5951  
    1616 * Output a validated user id
    1717 *
    18  * @since bbPress (r2729)
     18 * @since 2.0.0 bbPress (r2729)
    1919 *
    2020 * @param int $user_id Optional. User id
     
    2929     * Return a validated user id
    3030     *
    31      * @since bbPress (r2729)
     31     * @since 2.0.0 bbPress (r2729)
    3232     *
    3333     * @param int $user_id Optional. User id
     
    6464 * Output ID of current user
    6565 *
    66  * @since bbPress (r2574)
     66 * @since 2.0.0 bbPress (r2574)
    6767 *
    6868 * @uses bbp_get_current_user_id() To get the current user id
     
    7474     * Return ID of current user
    7575     *
    76      * @since bbPress (r2574)
     76     * @since 2.0.0 bbPress (r2574)
    7777     *
    7878     * @uses bbp_get_user_id() To get the current user id
     
    8787 * Output ID of displayed user
    8888 *
    89  * @since bbPress (r2688)
     89 * @since 2.0.0 bbPress (r2688)
    9090 *
    9191 * @uses bbp_get_displayed_user_id() To get the displayed user id
     
    9797     * Return ID of displayed user
    9898     *
    99      * @since bbPress (r2688)
     99     * @since 2.0.0 bbPress (r2688)
    100100     *
    101101     * @uses bbp_get_user_id() To get the displayed user id
     
    114114 * __get() method, it can also be used to get user_meta values.
    115115 *
    116  * @since bbPress (r2688)
     116 * @since 2.0.0 bbPress (r2688)
    117117 *
    118118 * @param string $field Field to get
     
    130130     * __get() method, it can also be used to get user_meta values.
    131131     *
    132      * @since bbPress (r2688)
     132     * @since 2.0.0 bbPress (r2688)
    133133     *
    134134     * @param string $field Field to get
     
    163163 * Output name of current user
    164164 *
    165  * @since bbPress (r2574)
     165 * @since 2.0.0 bbPress (r2574)
    166166 *
    167167 * @uses bbp_get_current_user_name() To get the current user name
     
    173173     * Return name of current user
    174174     *
    175      * @since bbPress (r2574)
     175     * @since 2.0.0 bbPress (r2574)
    176176     *
    177177     * @uses apply_filters() Calls 'bbp_get_current_user_name' with the
     
    190190 * Output avatar of current user
    191191 *
    192  * @since bbPress (r2574)
     192 * @since 2.0.0 bbPress (r2574)
    193193 *
    194194 * @param int $size Size of the avatar. Defaults to 40
     
    202202     * Return avatar of current user
    203203     *
    204      * @since bbPress (r2574)
     204     * @since 2.0.0 bbPress (r2574)
    205205     *
    206206     * @param int $size Size of the avatar. Defaults to 40
     
    228228 * Output link to the profile page of a user
    229229 *
    230  * @since bbPress (r2688)
     230 * @since 2.0.0 bbPress (r2688)
    231231 *
    232232 * @param int $user_id Optional. User id
     
    239239     * Return link to the profile page of a user
    240240     *
    241      * @since bbPress (r2688)
     241     * @since 2.0.0 bbPress (r2688)
    242242     *
    243243     * @param int $user_id Optional. User id
     
    266266 * Output a users nicename to the screen
    267267 *
    268  * @since bbPress (r4671)
     268 * @since 2.3.0 bbPress (r4671)
    269269 *
    270270 * @param int $user_id User ID whose nicename to get
     
    277277     * Return a users nicename to the screen
    278278     *
    279      * @since bbPress (r4671)
     279     * @since 2.3.0 bbPress (r4671)
    280280     *
    281281     * @param int $user_id User ID whose nicename to get
     
    319319 * Output URL to the profile page of a user
    320320 *
    321  * @since bbPress (r2688)
     321 * @since 2.0.0 bbPress (r2688)
    322322 *
    323323 * @param int $user_id Optional. User id
     
    331331     * Return URL to the profile page of a user
    332332     *
    333      * @since bbPress (r2688)
     333     * @since 2.0.0 bbPress (r2688)
    334334     *
    335335     * @param int $user_id Optional. User id
     
    382382 * Output link to the profile edit page of a user
    383383 *
    384  * @since bbPress (r2688)
     384 * @since 2.0.0 bbPress (r2688)
    385385 *
    386386 * @param int $user_id Optional. User id
     
    393393     * Return link to the profile edit page of a user
    394394     *
    395      * @since bbPress (r2688)
     395     * @since 2.0.0 bbPress (r2688)
    396396     *
    397397     * @param int $user_id Optional. User id
     
    419419 * Output URL to the profile edit page of a user
    420420 *
    421  * @since bbPress (r2688)
     421 * @since 2.0.0 bbPress (r2688)
    422422 *
    423423 * @param int $user_id Optional. User id
     
    431431     * Return URL to the profile edit page of a user
    432432     *
    433      * @since bbPress (r2688)
     433     * @since 2.0.0 bbPress (r2688)
    434434     *
    435435     * @param int $user_id Optional. User id
     
    479479 * Output a user's main role for display
    480480 *
    481  * @since bbPress (r3860)
     481 * @since 2.1.0 bbPress (r3860)
    482482 *
    483483 * @param int $user_id
     
    490490     * Return a user's main role for display
    491491     *
    492      * @since bbPress (r3860)
     492     * @since 2.1.0 bbPress (r3860)
    493493     *
    494494     * @param int $user_id
     
    530530 * Output the link to the admin section
    531531 *
    532  * @since bbPress (r2827)
     532 * @since 2.0.0 bbPress (r2827)
    533533 *
    534534 * @param array $args Optional. See {@link bbp_get_admin_link()}
     
    541541     * Return the link to the admin section
    542542     *
    543      * @since bbPress (r2827)
     543     * @since 2.0.0 bbPress (r2827)
    544544     *
    545545     * @param array $args Optional. This function supports these arguments:
     
    578578 * Output the author IP address of a post
    579579 *
    580  * @since bbPress (r3120)
     580 * @since 2.0.0 bbPress (r3120)
    581581 *
    582582 * @param array $args Optional. If it is an integer, it is used as post id.
     
    589589     * Return the author IP address of a post
    590590     *
    591      * @since bbPress (r3120)
     591     * @since 2.0.0 bbPress (r3120)
    592592     *
    593593     * @param array $args Optional. If an integer, it is used as reply id.
     
    629629 * and reply author information in the anonymous form template-part.
    630630 *
    631  * @since bbPress (r5119)
     631 * @since 2.5.0 bbPress (r5119)
    632632 *
    633633 * @param int $post_id
     
    645645     * and reply author information in the anonymous form template-part.
    646646     *
    647      * @since bbPress (r5119)
     647     * @since 2.5.0 bbPress (r5119)
    648648     *
    649649     * @param int $post_id
     
    685685 * and reply author information in the anonymous user form template-part.
    686686 *
    687  * @since bbPress (r5119)
     687 * @since 2.5.0 bbPress (r5119)
    688688 *
    689689 * @param int $post_id
     
    701701     * and reply author information in the anonymous user form template-part.
    702702     *
    703      * @since bbPress (r5119)
     703     * @since 2.5.0 bbPress (r5119)
    704704     *
    705705     * @param int $post_id
     
    741741 * and reply author information in the anonymous user form template-part.
    742742 *
    743  * @since bbPress (r5119)
     743 * @since 2.5.0 bbPress (r5119)
    744744 *
    745745 * @param int $post_id
     
    757757     * and reply author information in the anonymous user form template-part.
    758758     *
    759      * @since bbPress (r5119)
     759     * @since 2.5.0 bbPress (r5119)
    760760     *
    761761     * @param int $post_id
     
    795795 * Output the link to the user's favorites page (profile page)
    796796 *
    797  * @since bbPress (r2652)
     797 * @since 2.0.0 bbPress (r2652)
    798798 *
    799799 * @param int $user_id Optional. User id
     
    806806     * Return the link to the user's favorites page (profile page)
    807807     *
    808      * @since bbPress (r2652)
     808     * @since 2.0.0 bbPress (r2652)
    809809     *
    810810     * @param int $user_id Optional. User id
     
    849849 * Output the link to make a topic favorite/remove a topic from favorites
    850850 *
    851  * @since bbPress (r2652)
     851 * @since 2.0.0 bbPress (r2652)
    852852 *
    853853 * @param array $args See {@link bbp_get_user_favorites_link()}
     
    865865     * favorites
    866866     *
    867      * @since bbPress (r2652)
     867     * @since 2.0.0 bbPress (r2652)
    868868     *
    869869     * @param array $args This function supports these arguments:
     
    953953 * Output the link to the user's subscriptions page (profile page)
    954954 *
    955  * @since bbPress (r2688)
     955 * @since 2.0.0 bbPress (r2688)
    956956 *
    957957 * @param int $user_id Optional. User id
     
    964964     * Return the link to the user's subscriptions page (profile page)
    965965     *
    966      * @since bbPress (r2688)
     966     * @since 2.0.0 bbPress (r2688)
    967967     *
    968968     * @param int $user_id Optional. User id
     
    10071007 * Output the link to subscribe/unsubscribe from a topic
    10081008 *
    1009  * @since bbPress (r2668)
     1009 * @since 2.0.0 bbPress (r2668)
    10101010 *
    10111011 * @param array $args See {@link bbp_get_user_subscribe_link()}
     
    10201020     * Return the link to subscribe/unsubscribe from a forum or topic
    10211021     *
    1022      * @since bbPress (r2668)
     1022     * @since 2.0.0 bbPress (r2668)
    10231023     *
    10241024     * @param array $args This function supports these arguments:
     
    11501150 * Display profile edit success notice on user edit page
    11511151 *
    1152  * @since bbPress (r2688)
     1152 * @since 2.0.0 bbPress (r2688)
    11531153 *
    11541154 * @uses bbp_is_single_user() To check if it's the profile page
     
    11791179 * Display pending email change notice on user edit page
    11801180 *
    1181  * @since bbPress (r5660)
     1181 * @since 2.6.0 bbPress (r5660)
    11821182 *
    11831183 * @uses bbp_get_displayed_user_id()     To get the displayed user ID
     
    12291229 * Super admin privileges notice
    12301230 *
    1231  * @since bbPress (r2688)
     1231 * @since 2.0.0 bbPress (r2688)
    12321232 *
    12331233 * @uses is_multisite() To check if the blog is multisite
     
    12561256 * Drop down for selecting the user's display name
    12571257 *
    1258  * @since bbPress (r2688)
     1258 * @since 2.0.0 bbPress (r2688)
    12591259 */
    12601260function bbp_edit_user_display_name() {
     
    13041304 * Output blog role selector (for user edit)
    13051305 *
    1306  * @since bbPress (r2688)
     1306 * @since 2.0.0 bbPress (r2688)
    13071307 */
    13081308function bbp_edit_user_blog_role() {
     
    13361336 * Output forum role selector (for user edit)
    13371337 *
    1338  * @since bbPress (r4284)
     1338 * @since 2.2.0 bbPress (r4284)
    13391339 */
    13401340function bbp_edit_user_forums_role() {
     
    13731373 * Return user contact methods Selectbox
    13741374 *
    1375  * @since bbPress (r2688)
     1375 * @since 2.0.0 bbPress (r2688)
    13761376 *
    13771377 * @uses _wp_get_user_contactmethods() To get the contact methods
     
    13921392 * Output the link to the user's topics
    13931393 *
    1394  * @since bbPress (r4225)
     1394 * @since 2.2.0 bbPress (r4225)
    13951395 *
    13961396 * @param int $user_id Optional. User id
     
    14031403     * Return the link to the user's topics
    14041404     *
    1405      * @since bbPress (r4225)
     1405     * @since 2.2.0 bbPress (r4225)
    14061406     *
    14071407     * @param int $user_id Optional. User id
     
    14481448 * Output the link to the user's replies
    14491449 *
    1450  * @since bbPress (r4225)
     1450 * @since 2.2.0 bbPress (r4225)
    14511451 *
    14521452 * @param int $user_id Optional. User id
     
    14591459     * Return the link to the user's replies
    14601460     *
    1461      * @since bbPress (r4225)
     1461     * @since 2.2.0 bbPress (r4225)
    14621462     *
    14631463     * @param int $user_id Optional. User id
     
    15041504 * Handle the login and registration template notices
    15051505 *
    1506  * @since bbPress (r2970)
     1506 * @since 2.0.0 bbPress (r2970)
    15071507 *
    15081508 * @uses WP_Error bbPress::errors::add() To add an error or message
     
    15471547 * where the user should never have access to the contents of that file.
    15481548 *
    1549  * @since bbPress (r2815)
     1549 * @since 2.0.0 bbPress (r2815)
    15501550 *
    15511551 * @param string $url The URL to redirect to
     
    15721572 * Output the required hidden fields when logging in
    15731573 *
    1574  * @since bbPress (r2815)
     1574 * @since 2.0.0 bbPress (r2815)
    15751575 *
    15761576 * @uses apply_filters() To allow custom redirection
     
    15981598 * Output the required hidden fields when registering
    15991599 *
    1600  * @since bbPress (r2815)
     1600 * @since 2.0.0 bbPress (r2815)
    16011601 *
    16021602 * @uses add_query_arg() To add query args
     
    16271627 * Output the required hidden fields when user lost password
    16281628 *
    1629  * @since bbPress (r2815)
     1629 * @since 2.0.0 bbPress (r2815)
    16301630 *
    16311631 * @uses apply_filters() To allow custom redirection
     
    16531653 * Output the author link of a post
    16541654 *
    1655  * @since bbPress (r2875)
     1655 * @since 2.0.0 bbPress (r2875)
    16561656 *
    16571657 * @param array $args Optional. If it is an integer, it is used as post id.
     
    16641664     * Return the author link of the post
    16651665     *
    1666      * @since bbPress (r2875)
     1666     * @since 2.0.0 bbPress (r2875)
    16671667     *
    16681668     * @param array $args Optional. If an integer, it is used as reply id.
     
    17531753 * Check if the user can access a specific forum
    17541754 *
    1755  * @since bbPress (r3127)
     1755 * @since 2.0.0 bbPress (r3127)
    17561756 *
    17571757 * @uses bbp_get_current_user_id()
     
    18071807 * Check if the current user can publish topics
    18081808 *
    1809  * @since bbPress (r3127)
     1809 * @since 2.0.0 bbPress (r3127)
    18101810 *
    18111811 * @uses bbp_is_user_keymaster()
     
    18431843 * Check if the current user can publish forums
    18441844 *
    1845  * @since bbPress (r3549)
     1845 * @since 2.1.0 bbPress (r3549)
    18461846 *
    18471847 * @uses bbp_is_user_keymaster()
     
    18731873 * Check if the current user can publish replies
    18741874 *
    1875  * @since bbPress (r3127)
     1875 * @since 2.0.0 bbPress (r3127)
    18761876 *
    18771877 * @uses bbp_is_user_keymaster()
     
    19171917 * Get the forums the current user has the ability to see and post to
    19181918 *
    1919  * @since bbPress (r3127)
     1919 * @since 2.0.0 bbPress (r3127)
    19201920 *
    19211921 * @uses bbp_get_forum_post_type()
     
    19701970 * Performs a series of checks to ensure the current user can create forums.
    19711971 *
    1972  * @since bbPress (r3549)
     1972 * @since 2.1.0 bbPress (r3549)
    19731973 *
    19741974 * @uses bbp_is_user_keymaster()
     
    20042004 * Performs a series of checks to ensure the current user can create topics.
    20052005 *
    2006  * @since bbPress (r3127)
     2006 * @since 2.0.0 bbPress (r3127)
    20072007 *
    20082008 * @uses bbp_is_user_keymaster()
     
    20402040 * Performs a series of checks to ensure the current user can create replies.
    20412041 *
    2042  * @since bbPress (r3127)
     2042 * @since 2.0.0 bbPress (r3127)
    20432043 *
    20442044 * @uses bbp_is_user_keymaster()
     
    20772077 * anonymous user form fields.
    20782078 *
    2079  * @since bbPress (r5119)
     2079 * @since 2.5.0 bbPress (r5119)
    20802080 *
    20812081 * @uses bbp_is_anonymous()
Note: See TracChangeset for help on using the changeset viewer.