Skip to:
Content

bbPress.org


Ignore:
Timestamp:
10/28/2015 04:07:50 AM (10 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/common/widgets.php

    r5845 r5951  
    1818 * Adds a widget which displays the login form
    1919 *
    20  * @since bbPress (r2827)
     20 * @since 2.0.0 bbPress (r2827)
    2121 *
    2222 * @uses WP_Widget
    … …  
    2929     * Registers the login widget
    3030     *
    31      * @since bbPress (r2827)
     31     * @since 2.0.0 bbPress (r2827)
    3232     *
    3333     * @uses apply_filters() Calls 'bbp_login_widget_options' with the
    … …  
    4646     * Register the widget
    4747     *
    48      * @since bbPress (r3389)
     48     * @since 2.0.0 bbPress (r3389)
    4949     *
    5050     * @uses register_widget()
    … …  
    5757     * Displays the output, the login form
    5858     *
    59      * @since bbPress (r2827)
     59     * @since 2.0.0 bbPress (r2827)
    6060     *
    6161     * @param array $args Arguments
    … …  
    154154     * Update the login widget options
    155155     *
    156      * @since bbPress (r2827)
     156     * @since 2.0.0 bbPress (r2827)
    157157     *
    158158     * @param array $new_instance The new instance options
    … …  
    171171     * Output the login widget options form
    172172     *
    173      * @since bbPress (r2827)
     173     * @since 2.0.0 bbPress (r2827)
    174174     *
    175175     * @param $instance Instance
    … …  
    203203     * Merge the widget settings into defaults array.
    204204     *
    205      * @since bbPress (r4802)
     205     * @since 2.3.0 bbPress (r4802)
    206206     *
    207207     * @param $instance Instance
    … …  
    222222 * Adds a widget which displays the view list
    223223 *
    224  * @since bbPress (r3020)
     224 * @since 2.0.0 bbPress (r3020)
    225225 *
    226226 * @uses WP_Widget
    … …  
    233233     * Registers the view widget
    234234     *
    235      * @since bbPress (r3020)
     235     * @since 2.0.0 bbPress (r3020)
    236236     *
    237237     * @uses apply_filters() Calls 'bbp_views_widget_options' with the
    … …  
    250250     * Register the widget
    251251     *
    252      * @since bbPress (r3389)
     252     * @since 2.0.0 bbPress (r3389)
    253253     *
    254254     * @uses register_widget()
    … …  
    261261     * Displays the output, the view list
    262262     *
    263      * @since bbPress (r3020)
     263     * @since 2.0.0 bbPress (r3020)
    264264     *
    265265     * @param array $args Arguments
    … …  
    308308     * Update the view widget options
    309309     *
    310      * @since bbPress (r3020)
     310     * @since 2.0.0 bbPress (r3020)
    311311     *
    312312     * @param array $new_instance The new instance options
    … …  
    323323     * Output the view widget options form
    324324     *
    325      * @since bbPress (r3020)
     325     * @since 2.0.0 bbPress (r3020)
    326326     *
    327327     * @param $instance Instance
    … …  
    346346     * Merge the widget settings into defaults array.
    347347     *
    348      * @since bbPress (r4802)
     348     * @since 2.3.0 bbPress (r4802)
    349349     *
    350350     * @param $instance Instance
    … …  
    363363 * Adds a widget which displays the forum search form
    364364 *
    365  * @since bbPress (r4579)
     365 * @since 2.3.0 bbPress (r4579)
    366366 *
    367367 * @uses WP_Widget
    … …  
    374374     * Registers the search widget
    375375     *
    376      * @since bbPress (r4579)
     376     * @since 2.3.0 bbPress (r4579)
    377377     *
    378378     * @uses apply_filters() Calls 'bbp_search_widget_options' with the
    … …  
    391391     * Register the widget
    392392     *
    393      * @since bbPress (r4579)
     393     * @since 2.3.0 bbPress (r4579)
    394394     *
    395395     * @uses register_widget()
    … …  
    402402     * Displays the output, the search form
    403403     *
    404      * @since bbPress (r4579)
     404     * @since 2.3.0 bbPress (r4579)
    405405     *
    406406     * @uses apply_filters() Calls 'bbp_search_widget_title' with the title
    … …  
    437437     * Update the widget options
    438438     *
    439      * @since bbPress (r4579)
     439     * @since 2.3.0 bbPress (r4579)
    440440     *
    441441     * @param array $new_instance The new instance options
    … …  
    452452     * Output the search widget options form
    453453     *
    454      * @since bbPress (r4579)
     454     * @since 2.3.0 bbPress (r4579)
    455455     *
    456456     * @param $instance Instance
    … …  
    475475     * Merge the widget settings into defaults array.
    476476     *
    477      * @since bbPress (r4802)
     477     * @since 2.3.0 bbPress (r4802)
    478478     *
    479479     * @param $instance Instance
    … …  
    492492 * Adds a widget which displays the forum list
    493493 *
    494  * @since bbPress (r2653)
     494 * @since 2.0.0 bbPress (r2653)
    495495 *
    496496 * @uses WP_Widget
    … …  
    503503     * Registers the forum widget
    504504     *
    505      * @since bbPress (r2653)
     505     * @since 2.0.0 bbPress (r2653)
    506506     *
    507507     * @uses apply_filters() Calls 'bbp_forums_widget_options' with the
    … …  
    520520     * Register the widget
    521521     *
    522      * @since bbPress (r3389)
     522     * @since 2.0.0 bbPress (r3389)
    523523     *
    524524     * @uses register_widget()
    … …  
    531531     * Displays the output, the forum list
    532532     *
    533      * @since bbPress (r2653)
     533     * @since 2.0.0 bbPress (r2653)
    534534     *
    535535     * @param array $args Arguments
    … …  
    604604     * Update the forum widget options
    605605     *
    606      * @since bbPress (r2653)
     606     * @since 2.0.0 bbPress (r2653)
    607607     *
    608608     * @param array $new_instance The new instance options
    … …  
    625625     * Output the forum widget options form
    626626     *
    627      * @since bbPress (r2653)
     627     * @since 2.0.0 bbPress (r2653)
    628628     *
    629629     * @param $instance Instance
    … …  
    658658     * Merge the widget settings into defaults array.
    659659     *
    660      * @since bbPress (r4802)
     660     * @since 2.3.0 bbPress (r4802)
    661661     *
    662662     * @param $instance Instance
    … …  
    676676 * Adds a widget which displays the topic list
    677677 *
    678  * @since bbPress (r2653)
     678 * @since 2.0.0 bbPress (r2653)
    679679 *
    680680 * @uses WP_Widget
    … …  
    687687     * Registers the topic widget
    688688     *
    689      * @since bbPress (r2653)
     689     * @since 2.0.0 bbPress (r2653)
    690690     *
    691691     * @uses apply_filters() Calls 'bbp_topics_widget_options' with the
    … …  
    704704     * Register the widget
    705705     *
    706      * @since bbPress (r3389)
     706     * @since 2.0.0 bbPress (r3389)
    707707     *
    708708     * @uses register_widget()
    … …  
    715715     * Displays the output, the topic list
    716716     *
    717      * @since bbPress (r2653)
     717     * @since 2.0.0 bbPress (r2653)
    718718     *
    719719     * @param array $args
    … …  
    845845     * Update the topic widget options
    846846     *
    847      * @since bbPress (r2653)
     847     * @since 2.0.0 bbPress (r2653)
    848848     *
    849849     * @param array $new_instance The new instance options
    … …  
    870870     * Output the topic widget options form
    871871     *
    872      * @since bbPress (r2653)
     872     * @since 2.0.0 bbPress (r2653)
    873873     *
    874874     * @param $instance Instance
    … …  
    912912     * Merge the widget settings into defaults array.
    913913     *
    914      * @since bbPress (r4802)
     914     * @since 2.3.0 bbPress (r4802)
    915915     *
    916916     * @param $instance Instance
    … …  
    934934 * Adds a widget which displays the forum statistics
    935935 *
    936  * @since bbPress (r4509)
     936 * @since 2.3.0 bbPress (r4509)
    937937 *
    938938 * @uses WP_Widget
    … …  
    945945     * Registers the stats widget
    946946     *
    947      * @since bbPress (r4509)
     947     * @since 2.3.0 bbPress (r4509)
    948948     *
    949949     * @uses  apply_filters() Calls 'bbp_stats_widget_options' with the
    … …  
    962962     * Register the widget
    963963     *
    964      * @since bbPress (r4509)
     964     * @since 2.3.0 bbPress (r4509)
    965965     *
    966966     * @uses register_widget()
    … …  
    973973     * Displays the output, the statistics
    974974     *
    975      * @since bbPress (r4509)
     975     * @since 2.3.0 bbPress (r4509)
    976976     *
    977977     * @param array $args     Arguments
    … …  
    10061006     * Update the stats widget options
    10071007     *
    1008      * @since bbPress (r4509)
     1008     * @since 2.3.0 bbPress (r4509)
    10091009     *
    10101010     * @param array $new_instance The new instance options
    … …  
    10231023     * Output the stats widget options form
    10241024     *
    1025      * @since bbPress (r4509)
     1025     * @since 2.3.0 bbPress (r4509)
    10261026     *
    10271027     * @param $instance
    … …  
    10461046     * Merge the widget settings into defaults array.
    10471047     *
    1048      * @since bbPress (r4802)
     1048     * @since 2.3.0 bbPress (r4802)
    10491049     *
    10501050     * @param $instance Instance
    … …  
    10641064 * Adds a widget which displays the replies list
    10651065 *
    1066  * @since bbPress (r2653)
     1066 * @since 2.0.0 bbPress (r2653)
    10671067 *
    10681068 * @uses WP_Widget
    … …  
    10751075     * Registers the replies widget
    10761076     *
    1077      * @since bbPress (r2653)
     1077     * @since 2.0.0 bbPress (r2653)
    10781078     *
    10791079     * @uses apply_filters() Calls 'bbp_replies_widget_options' with the
    … …  
    10921092     * Register the widget
    10931093     *
    1094      * @since bbPress (r3389)
     1094     * @since 2.0.0 bbPress (r3389)
    10951095     *
    10961096     * @uses register_widget()
    … …  
    11031103     * Displays the output, the replies list
    11041104     *
    1105      * @since bbPress (r2653)
     1105     * @since 2.0.0 bbPress (r2653)
    11061106     *
    11071107     * @param array $args
    … …  
    12101210     * Update the reply widget options
    12111211     *
    1212      * @since bbPress (r2653)
     1212     * @since 2.0.0 bbPress (r2653)
    12131213     *
    12141214     * @param array $new_instance The new instance options
    … …  
    12281228     * Output the reply widget options form
    12291229     *
    1230      * @since bbPress (r2653)
     1230     * @since 2.0.0 bbPress (r2653)
    12311231     *
    12321232     * @param $instance Instance
    … …  
    12501250     * Merge the widget settings into defaults array.
    12511251     *
    1252      * @since bbPress (r4802)
     1252     * @since 2.3.0 bbPress (r4802)
    12531253     *
    12541254     * @param $instance Instance
Note: See TracChangeset for help on using the changeset viewer.