Changeset 32567

Timestamp:

05/24/2015 05:18:59 AM (9 years ago)

Author:

wonderboymusic

Message:

Add missing doc blocks to comment-template.php.

See #32444.

File:

• trunk/src/wp-includes/comment-template.php (modified) (16 diffs)

trunk/src/wp-includes/comment-template.php

@@ -64 +64 @@
      * @param int    $comment_ID The comment ID.
      */
-    $author = apply_filters( 'comment_author', $author, $comment_ID );
-    echo $author;
+    echo apply_filters( 'comment_author', $author, $comment_ID );
 }
 
@@ -158 +157 @@
  * @param string $before   Optional. Text or HTML to display before the email link. Default empty.
  * @param string $after    Optional. Text or HTML to display after the email link. Default empty.
+ * @return string
  */
 function get_comment_author_email_link( $linktext = '', $before = '', $after = '' ) {
@@ -226 +226 @@
  * @since 0.71
  *
- * @see get_comment_author_link() Echoes result
- *
  * @param int $comment_ID ID of the comment for which to print the author's
  *                        link. Default current comment.
@@ -391 +389 @@
  * @param bool         $echo       Optional. Whether to cho or return the output.
  *                                 Default true.
+ * @return string|null
  */
 function comment_class( $class = '', $comment_id = null, $post_id = null, $echo = true ) {
@@ -405 +404 @@
  *
  * @since 2.7.0
+ *
+ * @global int $comment_alt
+ * @global int $comment_depth
+ * @global int $comment_thread_alt
  *
  * @param string|array $class      Optional. One or more classes to add to the class list. Default empty.
@@ -596 +599 @@
  * @since 1.5.0
  *
+ * @global object $comment
+ *
  * @return int The comment ID.
  */
@@ -628 +633 @@
  *
  * @see get_page_of_comment()
+ *
+ * @global WP_Rewrite $wp_rewrite
+ * @global bool       $in_comment_loop
  *
  * @param mixed $comment Comment to retrieve. Default current comment.
@@ -857 +865 @@
  *
  * @since 1.5.0
+ *
+ * @global object $comment
  *
  * @param string $d         Optional. The format of the time. Default user's settings.
@@ -1116 +1126 @@
  * halted. It is advised for that reason, that the default theme is not deleted.
  *
- * @todo Document globals
  * @uses $withcomments Will not try to get the comments if the post has none.
  *
  * @since 1.5.0
+ *
+ * @global WP_Query $wp_query
+ * @global WP_Post  $post
+ * @global wpdb     $wpdb
+ * @global int      $id
+ * @global object   $comment
+ * @global string   $user_login
+ * @global int      $user_ID
+ * @global string   $user_identity
+ * @global bool     $overridden_cpage
  *
  * @param string $file              Optional. The file to load. Default '/comments.php'.
@@ -1371 +1390 @@
  */
 function get_comment_reply_link( $args = array(), $comment = null, $post = null ) {
-
     $defaults = array(
         'add_below'     => 'comment',
@@ -1551 +1569 @@
  *
  * @param string $text Optional. Text to display for cancel reply link. Default empty.
+ * @return string
  */
 function get_cancel_comment_reply_link( $text = '' ) {
@@ -1628 +1647 @@
  *
  * @since 2.7.0
+ *
+ * @global object $comment
  *
  * @param string $noreplytext  Optional. Text to display when not replying to a comment.
@@ -1687 +1708 @@
      *
      * @since 2.7.0
+     *
+     * @global int $comment_depth
      *
      * @param string $output Passed by reference. Used to append additional content.
@@ -1715 +1738 @@
      * @since 2.7.0
      *
+     * @global int $comment_depth
+     *
      * @param string $output Passed by reference. Used to append additional content.
      * @param int    $depth  Depth of comment.
@@ -1795 +1820 @@
      * @see Walker::start_el()
      * @see wp_list_comments()
+     *
+     * @global int    $comment_depth
+     * @global object $comment
      *
      * @param string $output  Passed by reference. Used to append additional content.
@@ -1998 +2026 @@
  *
  * @see WP_Query->comments
+ *
+ * @global WP_Query $wp_query
+ * @global int      $comment_alt
+ * @global int      $comment_depth
+ * @global int      $comment_thread_alt
+ * @global bool     $overridden_cpage
+ * @global bool     $in_comment_loop
  *
  * @param string|array $args {