Skip to:
Content

BuddyPress.org

Changeset 13896


Ignore:
Timestamp:
06/02/2024 05:45:18 PM (2 years ago)
Author:
espellcaste
Message:

PHPDoc: Correct placement of @since tags.

The @since tag should added before @global, @param, and @return.

Props shailu25
Closes ​https://github.com/buddypress/buddypress/pull/310
See #9164
Fixes #9168

Location:
trunk/src
Files:
5 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/bp-core/admin/bp-core-admin-functions.php

    r13879 r13896  
    2727 * The old "bp-general-settings" page was renamed "bp-components".
    2828 *
     29 * @since 1.6.0
     30 *
    2931 * @global array $_parent_pages
    3032 * @global array $_registered_pages
    3133 * @global array $submenu
    32  *
    33  * @since 1.6.0
    3434 */
    3535function bp_core_admin_backpat_menu() {
    … …  
    6868 * backpat "Help" page, the Activity page, or any third-party plugins.
    6969 *
     70 * @since 1.6.0
     71 *
    7072 * @global string $plugin_page
    7173 * @global array $submenu
    72  *
    73  * @since 1.6.0
    7474 */
    7575function bp_core_modify_admin_menu_highlight() {
    … …  
    221221 * The administrator will be shown a notice for each check that fails.
    222222 *
     223 * @since 1.2.0
     224 *
    223225 * @global wpdb $wpdb WordPress database object.
    224  *
    225  * @since 1.2.0
    226226 */
    227227function bp_core_activation_notice() {

  • trunk/src/bp-core/classes/class-bp-admin-types.php

    r13883 r13896  
    262262         * Override the Admin parent file to highlight the right menu.
    263263         *
     264         * @since 7.0.0
     265         *
    264266         * @global string $parent_file The parent file of the current admin screen.
    265          *
    266          * @since 7.0.0
    267267         */
    268268        public function screen_head() {

  • trunk/src/bp-core/classes/class-bp-user-query.php

    r13887 r13896  
    244244         * Prepare the query for user_ids.
    245245         *
     246         * @since 1.7.0
     247         *
    246248         * @global wpdb $wpdb WordPress database object.
    247          *
    248          * @since 1.7.0
    249249         */
    250250        public function prepare_user_ids_query() {
    … …  
    538538         * Also used to quickly perform user total counts.
    539539         *
     540         * @since 1.7.0
     541         *
    540542         * @global wpdb $wpdb WordPress database object.
    541          *
    542          * @since 1.7.0
    543543         */
    544544        public function do_user_ids_query() {

  • trunk/src/bp-friends/bp-friends-template.php

    r13844 r13896  
    8888         * Return value is a string of the form "x friends".
    8989         *
     90         * @since 1.2.0
     91         *
    9092         * @global BP_Core_Members_Template $members_template The main member template loop class.
    91          *
    92          * @since 1.2.0
    9393         *
    9494         * @return string A string of the form "x friends".

  • trunk/src/bp-messages/classes/class-bp-messages-notice.php

    r13414 r13896  
    7575         * Runs during constructor.
    7676         *
    77          * @global wpdb $wpdb WordPress database object.
    78          *
    79          * @since 1.0.0
     77         * @since 1.0.0
     78         *
     79         * @global wpdb $wpdb WordPress database object.
    8080         */
    8181        public function populate() {
    … …  
    9797         * Saves a notice.
    9898         *
    99          * @global wpdb $wpdb WordPress database object.
    100          *
    101          * @since 1.0.0
     99         * @since 1.0.0
     100         *
     101         * @global wpdb $wpdb WordPress database object.
    102102         *
    103103         * @return bool
    … …  
    180180         * Deletes a notice.
    181181         *
    182          * @global wpdb $wpdb WordPress database object.
    183          *
    184          * @since 1.0.0
     182         * @since 1.0.0
     183         *
     184         * @global wpdb $wpdb WordPress database object.
    185185         *
    186186         * @return bool
    … …  
    224224         * To get all notices, pass a value of -1 to pag_num.
    225225         *
    226          * @global wpdb $wpdb WordPress database object.
    227          *
    228          * @since 1.0.0
     226         * @since 1.0.0
     227         *
     228         * @global wpdb $wpdb WordPress database object.
    229229         *
    230230         * @param array $args {
    … …  
    275275         * Returns the total number of recorded notices.
    276276         *
    277          * @global wpdb $wpdb WordPress database object.
    278          *
    279          * @since 1.0.0
     277         * @since 1.0.0
     278         *
     279         * @global wpdb $wpdb WordPress database object.
    280280         *
    281281         * @return int
    … …  
    301301         * Returns the active notice that should be displayed on the front end.
    302302         *
    303          * @global wpdb $wpdb WordPress database object.
    304          *
    305          * @since 1.0.0
     303         * @since 1.0.0
     304         *
     305         * @global wpdb $wpdb WordPress database object.
    306306         *
    307307         * @return BP_Messages_Notice
Note: See TracChangeset for help on using the changeset viewer.