Changeset 5951 for trunk/src/includes/extend/buddypress/functions.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/functions.php (modified) (29 diffs)

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

@@ -19 +19 @@
  * This is used primarily for Notifications integration.
  *
- * @since bbPress (r5232)
+ * @since 2.6.0 bbPress (r5232)
+ *
  * @return string
  */
@@ -39 +40 @@
  * Filter the current bbPress user ID with the current BuddyPress user ID
  *
- * @since bbPress (r3552)
+ * @since 2.1.0 bbPress (r3552)
  *
  * @param int $user_id
@@ -78 +79 @@
  * Filter the bbPress is_single_user function with BuddyPress eqivalent
  *
- * @since bbPress (r3552)
+ * @since 2.1.0 bbPress (r3552)
  *
  * @param bool $is Optional. Default false
@@ -95 +96 @@
  * Filter the bbPress is_user_home function with BuddyPress eqivalent
  *
- * @since bbPress (r3552)
+ * @since 2.1.0 bbPress (r3552)
  *
  * @param bool $is Optional. Default false
@@ -112 +113 @@
  * Add the topic title to the <title> if viewing a single group forum topic
  *
- * @since bbPress (r5161)
+ * @since 2.5.0 bbPress (r5161)
  *
  * @param string $new_title The title to filter
@@ -150 +151 @@
  * Hook bbPress topics template into plugins template
  *
- * @since bbPress (r3552)
+ * @since 2.1.0 bbPress (r3552)
  *
  * @uses add_action() To add the content hook
@@ -163 +164 @@
  * Hook bbPress replies template into plugins template
  *
- * @since bbPress (r3552)
+ * @since 2.1.0 bbPress (r3552)
  *
  * @uses add_action() To add the content hook
@@ -176 +177 @@
  * Hook bbPress favorites template into plugins template
  *
- * @since bbPress (r3552)
+ * @since 2.1.0 bbPress (r3552)
  *
  * @uses add_action() To add the content hook
@@ -189 +190 @@
  * Hook bbPress subscriptions template into plugins template
  *
- * @since bbPress (r3552)
+ * @since 2.1.0 bbPress (r3552)
  *
  * @uses add_action() To add the content hook
@@ -204 +205 @@
  * Get the topics created template part
  *
- * @since bbPress (r3552)
+ * @since 2.1.0 bbPress (r3552)
  *
  * @uses bbp_get_template_part()s
@@ -223 +224 @@
  * Get the topics replied to template part
  *
- * @since bbPress (r3552)
+ * @since 2.1.0 bbPress (r3552)
  *
  * @uses bbp_get_template_part()
@@ -242 +243 @@
  * Get the topics favorited template part
  *
- * @since bbPress (r3552)
+ * @since 2.1.0 bbPress (r3552)
  *
  * @uses bbp_get_template_part()
@@ -261 +262 @@
  * Get the topics subscribed template part
  *
- * @since bbPress (r3552)
+ * @since 2.1.0 bbPress (r3552)
  *
  * @uses bbp_get_template_part()
@@ -290 +291 @@
  *
  * @param type $group_id
- * @since bbPress (r3653)
+ * @since 2.1.0 bbPress (r3653)
  */
 function bbp_get_group_forum_ids( $group_id = 0 ) {
@@ -322 +323 @@
  *
  * @param type $forum_id
- * @since bbPress (r3653)
+ * @since 2.1.0 bbPress (r3653)
  */
 function bbp_get_forum_group_ids( $forum_id = 0 ) {
@@ -354 +355 @@
  *
  * @param type $group_id
- * @since bbPress (r3653)
+ * @since 2.1.0 bbPress (r3653)
  */
 function bbp_update_group_forum_ids( $group_id = 0, $forum_ids = array() ) {
@@ -374 +375 @@
  *
  * @param type $forum_id
- * @since bbPress (r3653)
+ * @since 2.1.0 bbPress (r3653)
  */
 function bbp_update_forum_group_ids( $forum_id = 0, $group_ids = array() ) {
@@ -390 +391 @@
  *
  * @param type $group_id
- * @since bbPress (r3653)
+ * @since 2.1.0 bbPress (r3653)
  */
 function bbp_add_group_id_to_forum( $forum_id = 0, $group_id = 0 ) {
@@ -416 +417 @@
  *
  * @param type $group_id
- * @since bbPress (r3653)
+ * @since 2.1.0 bbPress (r3653)
  */
 function bbp_add_forum_id_to_group( $group_id = 0, $forum_id = 0 ) {
@@ -442 +443 @@
  *
  * @param type $group_id
- * @since bbPress (r3653)
+ * @since 2.1.0 bbPress (r3653)
  */
 function bbp_remove_group_id_from_forum( $forum_id = 0, $group_id = 0 ) {
@@ -468 +469 @@
  *
  * @param type $group_id
- * @since bbPress (r3653)
+ * @since 2.1.0 bbPress (r3653)
  */
 function bbp_remove_forum_id_from_group( $group_id = 0, $forum_id = 0 ) {
@@ -494 +495 @@
  *
  * @param type $group_id
- * @since bbPress (r3653)
+ * @since 2.1.0 bbPress (r3653)
  */
 function bbp_remove_group_id_from_all_forums( $group_id = 0 ) {
@@ -516 +517 @@
  *
  * @param type $forum_id
- * @since bbPress (r3653)
+ * @since 2.1.0 bbPress (r3653)
  */
 function bbp_remove_forum_id_from_all_groups( $forum_id = 0 ) {
@@ -533 +534 @@
  * Return true if a forum is a group forum
  *
- * @since bbPress (r4571)
+ * @since 2.3.0 bbPress (r4571)
  *
  * @param int $forum_id
@@ -560 +561 @@
  * Is the current user an admin of the current group
  *
- * @since bbPress (r4632)
+ * @since 2.3.0 bbPress (r4632)
  *
  * @uses is_user_logged_in()
@@ -591 +592 @@
  * Is the current user a moderator of the current group
  *
- * @since bbPress (r4632)
+ * @since 2.3.0 bbPress (r4632)
  *
  * @uses is_user_logged_in()
@@ -622 +623 @@
  * Is the current user a member of the current group
  *
- * @since bbPress (r4632)
+ * @since 2.3.0 bbPress (r4632)
  *
  * @uses is_user_logged_in()
@@ -653 +654 @@
  * Is the current user banned from the current group
  *
- * @since bbPress (r4632)
+ * @since 2.3.0 bbPress (r4632)
  *
  * @uses is_user_logged_in()
@@ -684 +685 @@
  * Is the current user the creator of the current group
  *
- * @since bbPress (r4632)
+ * @since 2.3.0 bbPress (r4632)
  *
  * @uses is_user_logged_in()