Changeset 13395 for trunk/src/bp-friends/bp-friends-template.php

Timestamp:

01/07/2023 12:18:55 AM (2 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-friends/bp-friends-template.php (modified) (4 diffs)

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

@@ -244 +244 @@
      * Return value is a string of the form "x friends".
      *
-     * @global BP_Core_Members_Template $members_template
+     * @global BP_Core_Members_Template $members_template The main member template loop class.
      *
      * @since 1.2.0
@@ -563 +563 @@
      * @since 1.2.0
      *
-     * @global BP_Core_Members_Template $members_template
+     * @global BP_Core_Members_Template $members_template The main member template loop class.
      *
      * @return int ID of the friendship.
@@ -598 +598 @@
      * @since 1.0.0
      *
-     * @global BP_Core_Members_Template $members_template
+     * @global BP_Core_Members_Template $members_template The main member template loop class.
      *
      * @return string accept-friendship URL.
@@ -635 +635 @@
      * @since 1.0.0
      *
-     * @global BP_Core_Members_Template $members_template
+     * @global BP_Core_Members_Template $members_template The main member template loop class.
      *
      * @return string reject-friendship URL.