Changeset 8956 for trunk/wp-includes/comment.php

Timestamp:

09/22/2008 08:21:10 PM (16 years ago)

Author:

azaozz

Message:

phpDoc corrections for comment.php, props jacobsantos, fixes #7550

File:

• trunk/wp-includes/comment.php (modified) (5 diffs)

trunk/wp-includes/comment.php

@@ -14 +14 @@
  * links exceeds the amount in the administration, then the check fails. If any
  * of the parameter contents match the blacklist of words, then the check fails.
+ *
+ * If the number of links exceeds the amount in the administration, then the
+ * check fails. If any of the parameter contents match the blacklist of words,
+ * then the check fails.
  *
  * If the comment is a trackback and part of the blogroll, then the trackback is
@@ -117 +121 @@
  * comment variable will be used, if it is set.
  *
+ * If the comment is empty, then the global comment variable will be used, if it
+ * is set.
+ *
  * @since 2.0.0
  * @uses $wpdb
@@ -592 +599 @@
  *
  * @param int $comment_id Comment ID
- * @return bool False if delete comment query failure, true on success
+ * @return bool False if delete comment query failure, true on success.
  */
 function wp_delete_comment($comment_id) {
@@ -728 +735 @@
  * @uses apply_filters() Calls 'pre_comment_author_email' hook on comment author's email address
  *
- * @param array $commentdata Contains information on the comment
- * @return array Parsed comment information
+ * @param array $commentdata Contains information on the comment.
+ * @return array Parsed comment information.
  */
 function wp_filter_comment($commentdata) {
@@ -776 +783 @@
  * @uses wp_insert_comment() Does the actual comment insertion to the database.
  *
- * @param array $commentdata Contains information on the comment
+ * @param array $commentdata Contains information on the comment.
  * @return int The ID of the comment after adding.
  */