From e85c0d94b957ec0ae6cc3207a018026bb63c58b0 Mon Sep 17 00:00:00 2001
From: Drew Jaynes <drewapicture@git.wordpress.org>
Date: Mon, 2 May 2016 20:03:24 +0000
Subject: [PATCH] Comments: Realign parameter documentation in the DocBlocks
 for `comment_author_email_link()` and `get_comment_author_email_link()`
 following [37348].

Also adds a missing return description for `get_comment_author_email_link()`.

Props flixos90 for the initial patch.
Fixes #36571.


git-svn-id: https://develop.svn.wordpress.org/trunk@37349 602fd350-edb4-49c9-b593-d223f7449a82
---
 src/wp-includes/comment-template.php | 23 ++++++++++++-----------
 1 file changed, 12 insertions(+), 11 deletions(-)

diff --git a/src/wp-includes/comment-template.php b/src/wp-includes/comment-template.php
index 3f177bdc46..8416cea9ac 100644
--- a/src/wp-includes/comment-template.php
+++ b/src/wp-includes/comment-template.php
@@ -140,11 +140,11 @@ function comment_author_email( $comment_ID = 0 ) {
  * @since 0.71
  * @since 4.6.0 The `$comment` parameter was added.
  *
- * @param string $linktext Optional. Text to display instead of the comment author's email address.
- *                         Default empty.
- * @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.
- * @param int|WP_Comment $comment Optional. Comment ID or WP_Comment object. Default is the current comment.
+ * @param string         $linktext Optional. Text to display instead of the comment author's email address.
+ *                                 Default empty.
+ * @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.
+ * @param int|WP_Comment $comment  Optional. Comment ID or WP_Comment object. Default is the current comment.
  */
 function comment_author_email_link( $linktext = '', $before = '', $after = '', $comment = null ) {
 	if ( $link = get_comment_author_email_link( $linktext, $before, $after, $comment ) ) {
@@ -164,12 +164,13 @@ function comment_author_email_link( $linktext = '', $before = '', $after = '', $
  * @since 2.7.0
  * @since 4.6.0 The `$comment` parameter was added.
  *
- * @param string $linktext Optional. Text to display instead of the comment author's email address.
- *                         Default empty.
- * @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.
- * @param int|WP_Comment $comment Optional. Comment ID or WP_Comment object. Default is the current comment.
- * @return string
+ * @param string         $linktext Optional. Text to display instead of the comment author's email address.
+ *                                 Default empty.
+ * @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.
+ * @param int|WP_Comment $comment  Optional. Comment ID or WP_Comment object. Default is the current comment.
+ * @return string HTML markup for the comment author email link. By default, the email address is obfuscated
+ *                via the {@see 'comment_email'} filter with antispambot().
  */
 function get_comment_author_email_link( $linktext = '', $before = '', $after = '', $comment = null ) {
 	$comment = get_comment( $comment );