Changeset 6526

Timestamp:

06/12/2017 02:21:34 PM (7 years ago)

Author:

johnjamesjacoby

Message:

Documentation: Don't use reply's, because it looks weird and is poor English grammar.

Prefer more descriptive documentation instead.

Location:

trunk/src/includes/replies

Files:

• functions.php (modified) (6 diffs)
• template.php (modified) (8 diffs)

trunk/src/includes/replies/functions.php

@@ -838 +838 @@
  * @uses bbp_update_reply_topic_id() To update the reply topic id
  * @uses bbp_update_reply_to() To update the reply to id
- * @uses bbp_update_reply_walker() To update the reply's ancestors' counts
+ * @uses bbp_update_reply_walker() To update the ancestor counts of a reply
  */
 function bbp_update_reply( $reply_id = 0, $topic_id = 0, $forum_id = 0, $anonymous_data = array(), $author_id = 0, $is_edit = false, $reply_to = 0 ) {
@@ -1063 +1063 @@
  * @uses bbp_get_reply_id() To get the reply id
  * @uses bbp_get_forum_id() To get the forum id
- * @uses get_post_ancestors() To get the reply's forum
+ * @uses get_post_ancestors() To get the ancestors of a reply
  * @uses get_post_field() To get the post type of the post
  * @uses update_post_meta() To update the reply forum id meta
  * @uses apply_filters() Calls 'bbp_update_reply_forum_id' with the forum id
  *                        and reply id
- * @return bool Reply's forum id
+ * @return bool The forum id of the reply
  */
 function bbp_update_reply_forum_id( $reply_id = 0, $forum_id = 0 ) {
@@ -1113 +1113 @@
  * @uses bbp_get_reply_id() To get the reply id
  * @uses bbp_get_topic_id() To get the topic id
- * @uses get_post_ancestors() To get the reply's topic
+ * @uses get_post_ancestors() To get the ancestors of a reply
  * @uses get_post_field() To get the post type of the post
  * @uses update_post_meta() To update the reply topic id meta
  * @uses apply_filters() Calls 'bbp_update_reply_topic_id' with the topic id
  *                        and reply id
- * @return bool Reply's topic id
+ * @return bool The topic id of the reply
  */
 function bbp_update_reply_topic_id( $reply_id = 0, $topic_id = 0 ) {
@@ -1155 +1155 @@
 
 /*
- * Update the reply's meta data with its reply to id
+ * Update the meta data with its parent reply-to id, of a reply
  *
  * @since 2.4.0 bbPress (r4944)
@@ -1165 +1165 @@
  * @uses apply_filters() Calls 'bbp_update_reply_to' with the reply id and
  *                        and reply to id
- * @return bool Reply's parent reply id
+ * @return bool The parent reply id of the reply
  */
 function bbp_update_reply_to( $reply_id = 0, $reply_to = 0 ) {
@@ -1343 +1343 @@
     /** Topic to Move From ***************************************************/
 
-    // Get the reply's current topic
+    // Get the current topic a reply is in
     $source_topic = bbp_get_topic( $move_reply->post_parent );
 

trunk/src/includes/replies/template.php

@@ -1169 +1169 @@
      * @uses apply_filters() Calls 'bbp_get_reply_author_display_name' with
      *                        the author display name and reply id
-     * @return string Reply's author's display name
+     * @return string The display name of the author of the reply
      */
     function bbp_get_reply_author_display_name( $reply_id = 0 ) {
@@ -1536 +1536 @@
      * @uses apply_filters() Calls 'bbp_get_reply_topic_title' with the
      *                        topic title and reply id
-     * @return string Reply's topic's title
+     * @return string The topic title of the reply
      */
     function bbp_get_reply_topic_title( $reply_id = 0 ) {
@@ -1568 +1568 @@
      * @uses apply_filters() Calls 'bbp_get_reply_topic_id' with the topic
      *                        id and reply id
-     * @return int Reply's topic id
+     * @return int The topic id of the reply
      */
     function bbp_get_reply_topic_id( $reply_id = 0 ) {
@@ -1609 +1609 @@
      * @uses apply_filters() Calls 'bbp_get_reply_forum_id' with the forum
      *                        id and reply id
-     * @return int Reply's forum id
+     * @return int The forum id of the reply
      */
     function bbp_get_reply_forum_id( $reply_id = 0 ) {
@@ -1630 +1630 @@
 
 /**
- * Output the reply's ancestor reply id
+ * Output the ancestor reply id of a reply
  *
  * @since 2.4.0 bbPress (r4944)
  *
  * @param int $reply_id Optional. Reply id
- * @uses bbp_get_reply_ancestor_id() To get the reply's ancestor id
+ * @uses bbp_get_reply_ancestor_id() To get the ancestor id of the reply
  */
 function bbp_reply_ancestor_id( $reply_id = 0 ) {
@@ -1641 +1641 @@
 }
     /**
-     * Return the reply's ancestor reply id
+     * Return the ancestor reply id of a reply
      *
      * @since 2.4.0 bbPress (r4944)
@@ -1689 +1689 @@
      * @uses apply_filters() Calls 'bbp_get_reply_to' with the reply to id and
      *                        reply id
-     * @return int Reply's reply to id
+     * @return int The parent reply id of the reply
      */
     function bbp_get_reply_to( $reply_id = 0 ) {
@@ -2503 +2503 @@
      * @param array Extra classes you can pass when calling this function
      * @uses bbp_get_reply_id() To validate the reply id
-     * @uses bbp_get_reply_forum_id() To get the reply's forum id
-     * @uses bbp_get_reply_topic_id() To get the reply's topic id
+     * @uses bbp_get_reply_forum_id() To get the forum id of the reply
+     * @uses bbp_get_reply_topic_id() To get the topic id of the reply
      * @uses get_post_class() To get all the classes including ours
      * @uses apply_filters() Calls 'bbp_get_reply_class' with the classes