Changeset 13395 for trunk/src/bp-blogs/bp-blogs-template.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-blogs/bp-blogs-template.php (modified) (11 diffs)

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

@@ -99 +99 @@
  * Rewind the blogs and reset blog index.
  *
- * @global BP_Blogs_Template $blogs_template {@link BP_Blogs_Template}
+ * @global BP_Blogs_Template $blogs_template The main blog template loop class.
  */
 function bp_rewind_blogs() {
@@ -120 +120 @@
  * @since 10.0.0 Added $date_query parameter
  *
- * @global BP_Blogs_Template $blogs_template {@link BP_Blogs_Template}
+ * @global BP_Blogs_Template $blogs_template The main blog template loop class.
  *
  * @param array|string $args {
@@ -203 +203 @@
  * Determine if there are still blogs left in the loop.
  *
- * @global object $blogs_template {@link BP_Blogs_Template}
+ * @global BP_Blogs_Template $blogs_template The main blog template loop class.
  *
  * @return bool Returns true when blogs are found.
@@ -216 +216 @@
  * Get the current blog object in the loop.
  *
- * @global object $blogs_template {@link BP_Blogs_Template}
+ * @global BP_Blogs_Template $blogs_template The main blog template loop class.
  *
  * @return object The current blog within the loop.
@@ -240 +240 @@
  * @since 2.7.0
  *
- * @global object $blogs_template {@link BP_Blogs_Template}
+ * @global BP_Blogs_Template $blogs_template The main blog template loop class.
  *
  * @return string
@@ -281 +281 @@
          * Return the blogs pagination links.
          *
-         * @global object $blogs_template {@link BP_Blogs_Template}
+         * @global BP_Blogs_Template $blogs_template The main blog template loop class.
          *
          * @return string HTML pagination links.
@@ -593 +593 @@
          * @since 1.7.0
          *
-         * @global BP_Blogs_Template $blogs_template
+         * @global BP_Blogs_Template $blogs_template The main blog template loop class.
          *
          * @param array $classes Array of custom classes.
@@ -765 +765 @@
          * @since 1.7.0
          *
-         * @global BP_Blogs_Template
+         * @global BP_Blogs_Template $blogs_template The main blog template loop class.
          *
          * @return string Post title.
@@ -802 +802 @@
          * @since 1.7.0
          *
-         * @global BP_Blogs_Template
+         * @global BP_Blogs_Template $blogs_template The main blog template loop class.
          *
          * @return string URL of the blog's latest post.
@@ -838 +838 @@
          * @since 1.7.0
          *
-         * @global BP_Blogs_Template
+         * @global BP_Blogs_Template $blogs_template The main blog template loop class.
          *
          * @return string Content of the blog's latest post.
@@ -877 +877 @@
          * @since 1.7.0
          *
-         * @global BP_Blogs_Template
+         * @global BP_Blogs_Template $blogs_template The main blog template loop class.
          *
          * @param string $size Image version to return. 'thumbnail', 'medium',