Skip to:
Content

bbPress.org


Ignore:
Timestamp:
10/28/2015 04:07:50 AM (6 years ago)
Author:
netweb
Message:

Standardize @since PHPDoc tags style and format

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:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/includes/extend/buddypress/activity.php

    r5857 r5951  
    1515 * Loads BuddyPress Activity extension
    1616 *
    17  * @since bbPress (r3395)
     17 * @since 2.0.0 bbPress (r3395)
    1818 *
    1919 * @package bbPress
     
    8585     * The bbPress BuddyPress Activity loader
    8686     *
    87      * @since bbPress (r3395)
     87     * @since 2.0.0 bbPress (r3395)
    8888     */
    8989    public function __construct() {
     
    9797     * Extension variables
    9898     *
    99      * @since bbPress (r3395)
     99     * @since 2.0.0 bbPress (r3395)
     100     *
    100101     * @access private
    101102     * @uses apply_filters() Calls various filters
     
    123124     * Setup the actions
    124125     *
    125      * @since bbPress (r3395)
     126     * @since 2.0.0 bbPress (r3395)
     127     *
    126128     * @access private
    127129     * @uses add_filter() To add various filters
     
    158160     * Setup the filters
    159161     *
    160      * @since bbPress (r3395)
     162     * @since 2.0.0 bbPress (r3395)
     163     *
    161164     * @access private
    162165     * @uses add_filter() To add various filters
     
    176179     * plugins and themes.
    177180     *
    178      * @since bbPress (r3902)
     181     * @since 2.1.0 bbPress (r3902)
    179182     */
    180183    private function fully_loaded() {
     
    187190     * Register our activity actions with BuddyPress
    188191     *
    189      * @since bbPress (r3395)
     192     * @since 2.0.0 bbPress (r3395)
     193     *
    190194     * @uses bp_activity_set_action()
    191195     */
     
    200204     * Wrapper for recoding bbPress actions to the BuddyPress activity stream
    201205     *
    202      * @since bbPress (r3395)
     206     * @since 2.0.0 bbPress (r3395)
     207     *
    203208     * @param type $args Array of arguments for bp_activity_add()
    204209     * @uses bbp_get_current_user_id()
     
    233238     * Wrapper for deleting bbPress actions from BuddyPress activity stream
    234239     *
    235      * @since bbPress (r3395)
     240     * @since 2.0.0 bbPress (r3395)
     241     *
    236242     * @param type $args Array of arguments for bp_activity_add()
    237243     * @uses bbp_get_current_user_id()
     
    288294     * Maybe disable activity stream comments on select actions
    289295     *
    290      * @since bbPress (r3399)
     296     * @since 2.0.0 bbPress (r3399)
     297     *
    291298     * @global BP_Activity_Template $activities_template
    292299     * @param boolean $can_comment
     
    326333     * Maybe link directly to topics and replies in activity stream entries
    327334     *
    328      * @since bbPress (r3399)
     335     * @since 2.0.0 bbPress (r3399)
     336     *
    329337     * @param string $link
    330338     * @param mixed $activity_object
     
    350358     * Append forum options to activity filter select box
    351359     *
    352      * @since bbPress (r3653)
     360     * @since 2.1.0 bbPress (r3653)
    353361     */
    354362    function activity_filter_options() {
     
    366374     * Record an activity stream entry when a topic is created or updated
    367375     *
    368      * @since bbPress (r3395)
     376     * @since 2.0.0 bbPress (r3395)
     377     *
    369378     * @param int $topic_id
    370379     * @param int $forum_id
     
    513522     * Record an activity stream entry when a reply is created
    514523     *
    515      * @since bbPress (r3395)
     524     * @since 2.0.0 bbPress (r3395)
     525     *
    516526     * @param int $topic_id
    517527     * @param int $forum_id
Note: See TracChangeset for help on using the changeset viewer.