Changeset 13395 for trunk/src/bp-messages/classes/class-bp-messages-notice.php

Timestamp:

01/07/2023 12:18:55 AM (4 years ago)

Author:

espellcaste

Message:

PHPDoc: adding improvements to the @global tag definition.

The @global tag is used to inform PHPDoc of a global variable or its usage. The tag was updated where necessary and invalid examples were removed.

Closes ​https://github.com/buddypress/buddypress/pull/53
Fixes #8786

File:

• trunk/src/bp-messages/classes/class-bp-messages-notice.php (modified) (6 diffs)

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

@@ -74 +74 @@
          * Runs during constructor.
          *
-         * @global BuddyPress $bp The one true BuddyPress instance.
          * @global wpdb $wpdb WordPress database object.
          *
@@ -97 +96 @@
          * Saves a notice.
          *
-         * @global BuddyPress $bp The one true BuddyPress instance.
          * @global wpdb $wpdb WordPress database object.
          *
@@ -181 +179 @@
          * Deletes a notice.
          *
-         * @global BuddyPress $bp The one true BuddyPress instance.
          * @global wpdb $wpdb WordPress database object.
          *
@@ -226 +223 @@
          * To get all notices, pass a value of -1 to pag_num.
          *
-         * @global BuddyPress $bp The one true BuddyPress instance.
          * @global wpdb $wpdb WordPress database object.
          *
@@ -278 +274 @@
          * Returns the total number of recorded notices.
          *
-         * @global BuddyPress $bp The one true BuddyPress instance.
          * @global wpdb $wpdb WordPress database object.
          *
@@ -305 +300 @@
          * Returns the active notice that should be displayed on the front end.
          *
-         * @global BuddyPress $bp The one true BuddyPress instance.
          * @global wpdb $wpdb WordPress database object.
          *