WP Merge to revision 8180

git-svn-id: http://svn.automattic.com/wordpress-mu/trunk@1336 7be80a69-a1ef-0310-a953-fb0f7c49ff36

1 files changed, 68 insertions, 64 deletions

diff --git a/wp-includes/comment-template.php b/wp-includes/comment-template.php
index 6e605a7..dcbd210 100644
--- a/wp-includes/comment-template.php
+++ b/wp-includes/comment-template.php
@@ -9,10 +9,10 @@
  */
 
 /**
- * get_comment_author() - Retrieve the author of the current comment
+ * Retrieve the author of the current comment.
  *
- * If the comment has an empty comment_author field, then 'Anonymous' person
- * is assumed.
+ * If the comment has an empty comment_author field, then 'Anonymous' person is
+ * assumed.
  *
  * @since 1.5
  * @uses apply_filters() Calls 'get_comment_author' hook on the comment author
@@ -29,7 +29,7 @@ function get_comment_author() {
 }
 
 /**
- * comment_author() - Displays the author of the current comment
+ * Displays the author of the current comment.
  *
  * @since 0.71
  * @uses apply_filters() Calls 'comment_author' on comment author before displaying
@@ -40,7 +40,7 @@ function comment_author() {
 }
 
 /**
- * get_comment_author_email() - Retrieve the email of the author of the current comment
+ * Retrieve the email of the author of the current comment.
  *
  * @since 1.5
  * @uses apply_filters() Calls the 'get_comment_author_email' hook on the comment author email
@@ -54,12 +54,13 @@ function get_comment_author_email() {
 }
 
 /**
- * comment_author_email() - Display the email of the author of the current global $comment
+ * Display the email of the author of the current global $comment.
  *
- * Care should be taken to protect the email address and assure that email harvesters
- * do not capture your commentors' email address. Most assume that their email address will
- * not appear in raw form on the blog. Doing so will enable anyone, including those that
- * people don't want to get the email address and use it for their own means good and bad.
+ * Care should be taken to protect the email address and assure that email
+ * harvesters do not capture your commentors' email address. Most assume that
+ * their email address will not appear in raw form on the blog. Doing so will
+ * enable anyone, including those that people don't want to get the email
+ * address and use it for their own means good and bad.
  *
  * @since 0.71
  * @uses apply_filters() Calls 'author_email' hook on the author email
@@ -69,12 +70,13 @@ function comment_author_email() {
 }
 
 /**
- * comment_author_email_link() - Display the html email link to the author of the current comment
+ * Display the html email link to the author of the current comment.
  *
- * Care should be taken to protect the email address and assure that email harvesters
- * do not capture your commentors' email address. Most assume that their email address will
- * not appear in raw form on the blog. Doing so will enable anyone, including those that
- * people don't want to get the email address and use it for their own means good and bad.
+ * Care should be taken to protect the email address and assure that email
+ * harvesters do not capture your commentors' email address. Most assume that
+ * their email address will not appear in raw form on the blog. Doing so will
+ * enable anyone, including those that people don't want to get the email
+ * address and use it for their own means good and bad.
  *
  * @since 0.71
  * @uses apply_filters() Calls 'comment_email' hook for the display of the comment author's email
@@ -96,7 +98,7 @@ function comment_author_email_link($linktext='', $before='', $after='') {
 }
 
 /**
- * get_comment_author_link() - Retrieve the html link to the url of the author of the current comment
+ * Retrieve the html link to the url of the author of the current comment.
  *
  * @since 1.5
  * @uses apply_filters() Calls 'get_comment_author_link' hook on the complete link HTML or author
@@ -116,7 +118,7 @@ function get_comment_author_link() {
 }
 
 /**
- * comment_author_link() - Display the html link to the url of the author of the current comment
+ * Display the html link to the url of the author of the current comment.
  *
  * @since 0.71
  * @see get_comment_author_link() Echos result
@@ -126,7 +128,7 @@ function comment_author_link() {
 }
 
 /**
- * get_comment_author_IP() - Retrieve the IP address of the author of the current comment
+ * Retrieve the IP address of the author of the current comment.
  *
  * @since 1.5
  * @uses $comment
@@ -140,7 +142,7 @@ function get_comment_author_IP() {
 }
 
 /**
- * comment_author_IP() - Displays the IP address of the author of the current comment
+ * Display the IP address of the author of the current comment.
  *
  * @since 0.71
  * @see get_comment_author_IP() Echos Result
@@ -150,7 +152,7 @@ function comment_author_IP() {
 }
 
 /**
- * get_comment_author_url() - Returns the url of the author of the current comment
+ * Retrieve the url of the author of the current comment.
  *
  * @since 1.5
  * @uses apply_filters() Calls 'get_comment_author_url' hook on the comment author's URL
@@ -163,7 +165,7 @@ function get_comment_author_url() {
 }
 
 /**
- * comment_author_url() - Display the url of the author of the current comment
+ * Display the url of the author of the current comment.
  *
  * @since 0.71
  * @uses apply_filters()
@@ -174,13 +176,14 @@ function comment_author_url() {
 }
 
 /**
- * get_comment_author_url_link() - Retrieves the HTML link of the url of the author of the current comment
+ * Retrieves the HTML link of the url of the author of the current comment.
  *
- * $linktext parameter is only used if the URL does not exist for the comment author. If the URL does
- * exist then the URL will be used and the $linktext will be ignored.
+ * $linktext parameter is only used if the URL does not exist for the comment
+ * author. If the URL does exist then the URL will be used and the $linktext
+ * will be ignored.
  *
- * Encapsulate the HTML link between the $before and $after. So it will appear in the order of $before,
- * link, and finally $after.
+ * Encapsulate the HTML link between the $before and $after. So it will appear
+ * in the order of $before, link, and finally $after.
  *
  * @since 1.5
  * @uses apply_filters() Calls the 'get_comment_author_url_link' on the complete HTML before returning.
@@ -202,7 +205,7 @@ function get_comment_author_url_link( $linktext = '', $before = '', $after = ''
 }
 
 /**
- * comment_author_url_link() - Displays the HTML link of the url of the author of the current comment
+ * Displays the HTML link of the url of the author of the current comment.
  *
  * @since 0.71
  * @see get_comment_author_url_link() Echos result
@@ -216,7 +219,7 @@ function comment_author_url_link( $linktext = '', $before = '', $after = '' ) {
 }
 
 /**
- * get_comment_date() - Retrieve the comment date of the current comment
+ * Retrieve the comment date of the current comment.
  *
  * @since 1.5
  * @uses apply_filters() Calls 'get_comment_date' hook with the formated date and the $d parameter respectively
@@ -235,7 +238,7 @@ function get_comment_date( $d = '' ) {
 }
 
 /**
- * comment_date() - Display the comment date of the current comment
+ * Display the comment date of the current comment.
  *
  * @since 0.71
  *
@@ -246,7 +249,7 @@ function comment_date( $d = '' ) {
 }
 
 /**
- * get_comment_excerpt() - Retrieve the excerpt of the current comment
+ * Retrieve the excerpt of the current comment.
  *
  * Will cut each word and only output the first 20 words with '...' at the end.
  * If the word count is less than 20, then no truncating is done and no '...'
@@ -278,7 +281,7 @@ function get_comment_excerpt() {
 }
 
 /**
- * comment_excerpt() - Returns the excerpt of the current comment
+ * Display the excerpt of the current comment.
  *
  * @since 1.2
  * @uses apply_filters() Calls 'comment_excerpt' hook before displaying excerpt
@@ -288,7 +291,7 @@ function comment_excerpt() {
 }
 
 /**
- * get_comment_ID() - Retrieve the comment id of the current comment
+ * Retrieve the comment id of the current comment.
  *
  * @since 1.5
  * @uses $comment
@@ -302,7 +305,7 @@ function get_comment_ID() {
 }
 
 /**
- * comment_ID() - Displays the comment id of the current comment
+ * Displays the comment id of the current comment.
  *
  * @since 0.71
  * @see get_comment_ID() Echos Result
@@ -312,7 +315,7 @@ function comment_ID() {
 }
 
 /**
- * get_comment_link() - Retrieve the link to the current comment
+ * Retrieve the link to the current comment.
  *
  * @since 1.5
  * @uses $comment
@@ -325,7 +328,7 @@ function get_comment_link() {
 }
 
 /**
- * get_comments_link() - Retrieves the link to the current post comments
+ * Retrieves the link to the current post comments.
  *
  * @since 1.5
  *
@@ -336,7 +339,7 @@ function get_comments_link() {
 }
 
 /**
- * comments_link() - Displays the link to the current post comments
+ * Displays the link to the current post comments.
  *
  * @since 0.71
  *
@@ -348,7 +351,7 @@ function comments_link( $deprecated = '', $deprecated = '' ) {
 }
 
 /**
- * get_comments_number() - Retrieve the amount of comments a post has
+ * Retrieve the amount of comments a post has.
  *
  * @since 1.5
  * @uses apply_filters() Calls the 'get_comments_number' hook on the number of comments
@@ -373,7 +376,7 @@ function get_comments_number( $post_id = 0 ) {
 }
 
 /**
- * comments_number() - Display the language string for the number of comments the current post has
+ * Display the language string for the number of comments the current post has.
  *
  * @since 0.71
  * @uses $id
@@ -399,7 +402,7 @@ function comments_number( $zero = false, $one = false, $more = false, $deprecate
 }
 
 /**
- * get_comment_text() - Retrieve the text of the current comment
+ * Retrieve the text of the current comment.
  *
  * @since 1.5
  * @uses $comment
@@ -412,7 +415,7 @@ function get_comment_text() {
 }
 
 /**
- * comment_text() - Displays the text of the current comment
+ * Displays the text of the current comment.
  *
  * @since 0.71
  * @uses apply_filters() Passes the comment content through the 'comment_text' hook before display
@@ -423,7 +426,7 @@ function comment_text() {
 }
 
 /**
- * get_comment_time() - Retrieve the comment time of the current comment
+ * Retrieve the comment time of the current comment.
  *
  * @since 1.5
  * @uses $comment
@@ -444,7 +447,7 @@ function get_comment_time( $d = '', $gmt = false ) {
 }
 
 /**
- * comment_time() - Display the comment time of the current comment
+ * Display the comment time of the current comment.
  *
  * @since 0.71
  *
@@ -455,7 +458,7 @@ function comment_time( $d = '' ) {
 }
 
 /**
- * get_comment_type() - Retrieve the comment type of the current comment
+ * Retrieve the comment type of the current comment.
  *
  * @since 1.5
  * @uses $comment
@@ -473,7 +476,7 @@ function get_comment_type() {
 }
 
 /**
- * comment_type() - Display the comment type of the current comment
+ * Display the comment type of the current comment.
  *
  * @since 0.71
  *
@@ -496,11 +499,11 @@ function comment_type($commenttxt = 'Comment', $trackbacktxt = 'Trackback', $pin
 }
 
 /**
- * get_trackback_url() - Retrieve The current post's trackback URL
+ * Retrieve The current post's trackback URL.
  *
- * There is a check to see if permalink's have been enabled and if so, will retrieve
- * the pretty path. If permalinks weren't enabled, the ID of the current post is used
- * and appended to the correct page to go to.
+ * There is a check to see if permalink's have been enabled and if so, will
+ * retrieve the pretty path. If permalinks weren't enabled, the ID of the
+ * current post is used and appended to the correct page to go to.
  *
  * @since 1.5
  * @uses apply_filters() Calls 'trackback_url' on the resulting trackback URL
@@ -519,7 +522,7 @@ function get_trackback_url() {
 }
 
 /**
- * trackback_url() - Displays the current post's trackback URL
+ * Displays the current post's trackback URL.
  *
  * @since 0.71
  * @uses get_trackback_url() Gets the trackback url for the current post
@@ -533,7 +536,7 @@ function trackback_url($deprecated = true) {
 }
 
 /**
- * trackback_rdf() - Generates and displays the RDF for the trackback information of current post
+ * Generates and displays the RDF for the trackback information of current post.
  *
  * @since 0.71
  *
@@ -557,7 +560,7 @@ function trackback_rdf($deprecated = '') {
 }
 
 /**
- * comments_open() - Whether the current post is open for comments
+ * Whether the current post is open for comments.
  *
  * @since 1.5
  * @uses $post
@@ -574,7 +577,7 @@ function comments_open( $post_id=NULL ) {
 }
 
 /**
- * pings_open() - Whether the current post is open for pings
+ * Whether the current post is open for pings.
  *
  * @since 1.5
  * @uses $post
@@ -591,14 +594,14 @@ function pings_open( $post_id = NULL ) {
 }
 
 /**
- * wp_comment_form_unfiltered_html_nonce() - Displays form token for unfiltered comments
+ * Displays form token for unfiltered comments.
  *
- * Will only display nonce token if the current user has permissions for unfiltered html.
- * Won't display the token for other users.
+ * Will only display nonce token if the current user has permissions for
+ * unfiltered html. Won't display the token for other users.
  *
- * The function was backported to 2.0.10 and was added to versions 2.1.3 and above. Does not
- * exist in versions prior to 2.0.10 in the 2.0 branch and in the 2.1 branch, prior to 2.1.3.
- * Technically added in 2.2.0.
+ * The function was backported to 2.0.10 and was added to versions 2.1.3 and
+ * above. Does not exist in versions prior to 2.0.10 in the 2.0 branch and in
+ * the 2.1 branch, prior to 2.1.3. Technically added in 2.2.0.
  *
  * @since 2.0.10 Backported to 2.0 branch
  * @since 2.1.3
@@ -611,10 +614,10 @@ function wp_comment_form_unfiltered_html_nonce() {
 }
 
 /**
- * comments_template() - Loads the comment template specified in $file
+ * Loads the comment template specified in $file.
  *
- * Will not display the comments template if not on single post or page, or
- * if the post does not have comments.
+ * Will not display the comments template if not on single post or page, or if
+ * the post does not have comments.
  *
  * Uses the WordPress database object to query for the comments. The comments
  * are passed through the 'comments_array' filter hook with the list of comments
@@ -669,7 +672,7 @@ function comments_template( $file = '/comments.php' ) {
 }
 
 /**
- * comments_popup_script() - Displays the JS popup script to show a comment
+ * Displays the JS popup script to show a comment.
  *
  * If the $file parameter is empty, then the home page is assumed. The defaults
  * for the window are 400px by 400px.
@@ -700,9 +703,10 @@ function comments_popup_script($width=400, $height=400, $file='') {
 }
 
 /**
- * comments_popup_link() - Displays the link to the comments popup window for the current post ID.
+ * Displays the link to the comments popup window for the current post ID.
  *
- * Is not meant to be displayed on single posts and pages. Should be used on the lists of posts
+ * Is not meant to be displayed on single posts and pages. Should be used on the
+ * lists of posts
  *
  * @since 0.71
  * @uses $id