Changeset 5951 for trunk/src/includes/extend/buddypress/activity.php

Timestamp:

10/28/2015 04:07:50 AM (10 years ago)

Author:

netweb

Message:

Standardize @since PHPDoc tags style and format

• e.g. @since 2.6.0 bbPress (r5951) YOLO
• See ​http://phpdoc.org/docs/latest/references/phpdoc/tags/since.html

This changeset updates the style and formatting of all of our @since instances for compatibility with phpDocumentor 2 and WP-Parser as we move toward implementing the bbPress developer code reference.

Props thebrandonallen
Fixes #2879

File:

• trunk/src/includes/extend/buddypress/activity.php (modified) (14 diffs)

trunk/src/includes/extend/buddypress/activity.php

@@ -15 +15 @@
  * Loads BuddyPress Activity extension
  *
- * @since bbPress (r3395)
+ * @since 2.0.0 bbPress (r3395)
  *
  * @package bbPress
@@ -85 +85 @@
      * The bbPress BuddyPress Activity loader
      *
-     * @since bbPress (r3395)
+     * @since 2.0.0 bbPress (r3395)
      */
     public function __construct() {
@@ -97 +97 @@
      * Extension variables
      *
-     * @since bbPress (r3395)
+     * @since 2.0.0 bbPress (r3395)
+     *
      * @access private
      * @uses apply_filters() Calls various filters
@@ -123 +124 @@
      * Setup the actions
      *
-     * @since bbPress (r3395)
+     * @since 2.0.0 bbPress (r3395)
+     *
      * @access private
      * @uses add_filter() To add various filters
@@ -158 +160 @@
      * Setup the filters
      *
-     * @since bbPress (r3395)
+     * @since 2.0.0 bbPress (r3395)
+     *
      * @access private
      * @uses add_filter() To add various filters
@@ -176 +179 @@
      * plugins and themes.
      *
-     * @since bbPress (r3902)
+     * @since 2.1.0 bbPress (r3902)
      */
     private function fully_loaded() {
@@ -187 +190 @@
      * Register our activity actions with BuddyPress
      *
-     * @since bbPress (r3395)
+     * @since 2.0.0 bbPress (r3395)
+     *
      * @uses bp_activity_set_action()
      */
@@ -200 +204 @@
      * Wrapper for recoding bbPress actions to the BuddyPress activity stream
      *
-     * @since bbPress (r3395)
+     * @since 2.0.0 bbPress (r3395)
+     *
      * @param type $args Array of arguments for bp_activity_add()
      * @uses bbp_get_current_user_id()
@@ -233 +238 @@
      * Wrapper for deleting bbPress actions from BuddyPress activity stream
      *
-     * @since bbPress (r3395)
+     * @since 2.0.0 bbPress (r3395)
+     *
      * @param type $args Array of arguments for bp_activity_add()
      * @uses bbp_get_current_user_id()
@@ -288 +294 @@
      * Maybe disable activity stream comments on select actions
      *
-     * @since bbPress (r3399)
+     * @since 2.0.0 bbPress (r3399)
+     *
      * @global BP_Activity_Template $activities_template
      * @param boolean $can_comment
@@ -326 +333 @@
      * Maybe link directly to topics and replies in activity stream entries
      *
-     * @since bbPress (r3399)
+     * @since 2.0.0 bbPress (r3399)
+     *
      * @param string $link
      * @param mixed $activity_object
@@ -350 +358 @@
      * Append forum options to activity filter select box
      *
-     * @since bbPress (r3653)
+     * @since 2.1.0 bbPress (r3653)
      */
     function activity_filter_options() {
@@ -366 +374 @@
      * Record an activity stream entry when a topic is created or updated
      *
-     * @since bbPress (r3395)
+     * @since 2.0.0 bbPress (r3395)
+     *
      * @param int $topic_id
      * @param int $forum_id
@@ -513 +522 @@
      * Record an activity stream entry when a reply is created
      *
-     * @since bbPress (r3395)
+     * @since 2.0.0 bbPress (r3395)
+     *
      * @param int $topic_id
      * @param int $forum_id