Docs: Add missing description for $comment global.

Props immeet94, mukesh27. Fixes #46928. See #47110. git-svn-id: https://develop.svn.wordpress.org/trunk@46391 602fd350-edb4-49c9-b593-d223f7449a82
WordPress · Oct 4, 2019 · c2bcdea · c2bcdea
1 parent 08ff597
commit c2bcdea
Show file tree

Hide file tree

Showing 7 changed files with 8 additions and 8 deletions.
diff --git a/src/wp-admin/includes/class-wp-comments-list-table.php b/src/wp-admin/includes/class-wp-comments-list-table.php
@@ -539,7 +539,7 @@ public function display() {
 
 	/**
 	 * @global WP_Post    $post    Global post object.
-	 * @global WP_Comment $comment
+	 * @global WP_Comment $comment Global comment object.
 	 *
 	 * @param WP_Comment $item
 	 */

diff --git a/src/wp-admin/includes/dashboard.php b/src/wp-admin/includes/dashboard.php
@@ -623,7 +623,7 @@ function wp_dashboard_recent_drafts( $drafts = false ) {
  * @access private
  * @since 2.7.0
  *
- * @global WP_Comment $comment
+ * @global WP_Comment $comment Global comment object.
  *
  * @param WP_Comment $comment   The current comment.
  * @param bool       $show_date Optional. Whether to display the date.

diff --git a/src/wp-includes/class-walker-comment.php b/src/wp-includes/class-walker-comment.php
@@ -161,7 +161,7 @@ public function display_element( $element, &$children_elements, $max_depth, $dep
 	 * @see Walker::start_el()
 	 * @see wp_list_comments()
 	 * @global int        $comment_depth
-	 * @global WP_Comment $comment
+	 * @global WP_Comment $comment       Global comment object.
 	 *
 	 * @param string     $output  Used to append additional content. Passed by reference.
 	 * @param WP_Comment $comment Comment data object.

diff --git a/src/wp-includes/class-wp-query.php b/src/wp-includes/class-wp-query.php
@@ -3351,7 +3351,7 @@ public function next_comment() {
 	 * Sets up the current comment.
 	 *
 	 * @since 2.2.0
-	 * @global WP_Comment $comment Current comment.
+	 * @global WP_Comment $comment Global comment object.
 	 */
 	public function the_comment() {
 		global $comment;

diff --git a/src/wp-includes/comment-template.php b/src/wp-includes/comment-template.php
@@ -1307,7 +1307,7 @@ function wp_comment_form_unfiltered_html_nonce() {
  * @global WP_Post    $post             Global post object.
  * @global wpdb       $wpdb             WordPress database abstraction object.
  * @global int        $id
- * @global WP_Comment $comment
+ * @global WP_Comment $comment          Global comment object.
  * @global string     $user_login
  * @global int        $user_ID
  * @global string     $user_identity
@@ -1922,7 +1922,7 @@ function comment_id_fields( $id = 0 ) {
  *
  * @since 2.7.0
  *
- * @global WP_Comment $comment Current comment.
+ * @global WP_Comment $comment Global comment object.
  *
  * @param string $noreplytext  Optional. Text to display when not replying to a comment.
  *                             Default false.

diff --git a/src/wp-includes/comment.php b/src/wp-includes/comment.php
@@ -184,7 +184,7 @@ function get_approved_comments( $post_id, $args = array() ) {
  *
  * @since 2.0.0
  *
- * @global WP_Comment $comment
+ * @global WP_Comment $comment Global comment object.
  *
  * @param WP_Comment|string|int $comment Comment to retrieve.
  * @param string                $output  Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which correspond to

diff --git a/src/wp-includes/template.php b/src/wp-includes/template.php
@@ -692,7 +692,7 @@ function locate_template( $template_names, $load = false, $require_once = true )
  * @global string     $wp_version
  * @global WP         $wp            Current WordPress environment instance.
  * @global int        $id
- * @global WP_Comment $comment
+ * @global WP_Comment $comment       Global comment object.
  * @global int        $user_ID
  *
  * @param string $_template_file Path to template file.