Skip to:
Content

bbPress.org


Ignore:
Timestamp:
06/16/2017 09:20:52 PM (7 years ago)
Author:
johnjamesjacoby
Message:

Documentation: Remove all @uses usages.

Per the WordPress inline documentation standards:

the @uses tag is not recommended to be used to indicate a used-by relationship, as this information can be derived through other means. These tags also are very likely to become out-of-date as our functions change over time.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/includes/common/widgets.php

    r6506 r6573  
    1919 *
    2020 * @since 2.0.0 bbPress (r2827)
    21  *
    22  * @uses WP_Widget
    2321 */
    2422class BBP_Login_Widget extends WP_Widget {
    … …  
    3028     *
    3129     * @since 2.0.0 bbPress (r2827)
    32      *
    33      * @uses apply_filters() Calls 'bbp_login_widget_options' with the
    34      *                        widget options
    3530     */
    3631    public function __construct() {
    … …  
    4742     *
    4843     * @since 2.0.0 bbPress (r3389)
    49      *
    50      * @uses register_widget()
    5144     */
    5245    public static function register_widget() {
    … …  
    6154     * @param array $args Arguments
    6255     * @param array $instance Instance
    63      * @uses apply_filters() Calls 'bbp_login_widget_title' with the title
    64      * @uses get_template_part() To get the login/logged in form
    6556     */
    6657    public function widget( $args = array(), $instance = array() ) {
    … …  
    174165     *
    175166     * @param $instance Instance
    176      * @uses BBP_Login_Widget::get_field_id() To output the field id
    177      * @uses BBP_Login_Widget::get_field_name() To output the field name
    178167     */
    179168    public function form( $instance = array() ) {
    … …  
    206195     *
    207196     * @param $instance Instance
    208      * @uses bbp_parse_args() To merge widget settings into defaults
    209197     */
    210198    public function parse_settings( $instance = array() ) {
    … …  
    223211 *
    224212 * @since 2.0.0 bbPress (r3020)
    225  *
    226  * @uses WP_Widget
    227213 */
    228214class BBP_Views_Widget extends WP_Widget {
    … …  
    234220     *
    235221     * @since 2.0.0 bbPress (r3020)
    236      *
    237      * @uses apply_filters() Calls 'bbp_views_widget_options' with the
    238      *                        widget options
    239222     */
    240223    public function __construct() {
    … …  
    251234     *
    252235     * @since 2.0.0 bbPress (r3389)
    253      *
    254      * @uses register_widget()
    255236     */
    256237    public static function register_widget() {
    … …  
    265246     * @param array $args Arguments
    266247     * @param array $instance Instance
    267      * @uses apply_filters() Calls 'bbp_view_widget_title' with the title
    268      * @uses bbp_get_views() To get the views
    269      * @uses bbp_view_url() To output the view url
    270      * @uses bbp_view_title() To output the view title
    271248     */
    272249    public function widget( $args = array(), $instance = array() ) {
    … …  
    332309     *
    333310     * @param $instance Instance
    334      * @uses BBP_Views_Widget::get_field_id() To output the field id
    335      * @uses BBP_Views_Widget::get_field_name() To output the field name
    336311     */
    337312    public function form( $instance = array() ) {
    … …  
    355330     *
    356331     * @param $instance Instance
    357      * @uses bbp_parse_args() To merge widget settings into defaults
    358332     */
    359333    public function parse_settings( $instance = array() ) {
    … …  
    370344 *
    371345 * @since 2.3.0 bbPress (r4579)
    372  *
    373  * @uses WP_Widget
    374346 */
    375347class BBP_Search_Widget extends WP_Widget {
    … …  
    381353     *
    382354     * @since 2.3.0 bbPress (r4579)
    383      *
    384      * @uses apply_filters() Calls 'bbp_search_widget_options' with the
    385      *                        widget options
    386355     */
    387356    public function __construct() {
    … …  
    398367     *
    399368     * @since 2.3.0 bbPress (r4579)
    400      *
    401      * @uses register_widget()
    402369     */
    403370    public static function register_widget() {
    … …  
    409376     *
    410377     * @since 2.3.0 bbPress (r4579)
    411      *
    412      * @uses apply_filters() Calls 'bbp_search_widget_title' with the title
    413      * @uses get_template_part() To get the search form
    414378     */
    415379    public function widget( $args, $instance ) {
    … …  
    461425     *
    462426     * @param $instance Instance
    463      * @uses BBP_Search_Widget::get_field_id() To output the field id
    464      * @uses BBP_Search_Widget::get_field_name() To output the field name
    465427     */
    466428    public function form( $instance ) {
    … …  
    484446     *
    485447     * @param $instance Instance
    486      * @uses bbp_parse_args() To merge widget settings into defaults
    487448     */
    488449    public function parse_settings( $instance = array() ) {
    … …  
    499460 *
    500461 * @since 2.0.0 bbPress (r2653)
    501  *
    502  * @uses WP_Widget
    503462 */
    504463class BBP_Forums_Widget extends WP_Widget {
    … …  
    510469     *
    511470     * @since 2.0.0 bbPress (r2653)
    512      *
    513      * @uses apply_filters() Calls 'bbp_forums_widget_options' with the
    514      *                        widget options
    515471     */
    516472    public function __construct() {
    … …  
    527483     *
    528484     * @since 2.0.0 bbPress (r3389)
    529      *
    530      * @uses register_widget()
    531485     */
    532486    public static function register_widget() {
    … …  
    541495     * @param array $args Arguments
    542496     * @param array $instance Instance
    543      * @uses apply_filters() Calls 'bbp_forum_widget_title' with the title
    544      * @uses get_option() To get the forums per page option
    545      * @uses current_user_can() To check if the current user can read
    546      *                           private() To resety name
    547      * @uses bbp_has_forums() The main forum loop
    548      * @uses bbp_forums() To check whether there are more forums available
    549      *                     in the loop
    550      * @uses bbp_the_forum() Loads up the current forum in the loop
    551      * @uses bbp_forum_permalink() To display the forum permalink
    552      * @uses bbp_forum_title() To display the forum title
    553497     */
    554498    public function widget( $args, $instance ) {
    … …  
    643587     *
    644588     * @param $instance Instance
    645      * @uses BBP_Forums_Widget::get_field_id() To output the field id
    646      * @uses BBP_Forums_Widget::get_field_name() To output the field name
    647589     */
    648590    public function form( $instance ) {
    … …  
    676618     *
    677619     * @param $instance Instance
    678      * @uses bbp_parse_args() To merge widget settings into defaults
    679620     */
    680621    public function parse_settings( $instance = array() ) {
    … …  
    692633 *
    693634 * @since 2.0.0 bbPress (r2653)
    694  *
    695  * @uses WP_Widget
    696635 */
    697636class BBP_Topics_Widget extends WP_Widget {
    … …  
    703642     *
    704643     * @since 2.0.0 bbPress (r2653)
    705      *
    706      * @uses apply_filters() Calls 'bbp_topics_widget_options' with the
    707      *                        widget options
    708644     */
    709645    public function __construct() {
    … …  
    720656     *
    721657     * @since 2.0.0 bbPress (r3389)
    722      *
    723      * @uses register_widget()
    724658     */
    725659    public static function register_widget() {
    … …  
    734668     * @param array $args
    735669     * @param array $instance
    736      * @uses apply_filters() Calls 'bbp_topic_widget_title' with the title
    737      * @uses bbp_topic_permalink() To display the topic permalink
    738      * @uses bbp_topic_title() To display the topic title
    739      * @uses bbp_get_topic_last_active_time() To get the topic last active
    740      *                                         time
    741      * @uses bbp_get_topic_id() To get the topic id
    742670     */
    743671    public function widget( $args = array(), $instance = array() ) {
    … …  
    926854     *
    927855     * @param $instance Instance
    928      * @uses BBP_Topics_Widget::get_field_id() To output the field id
    929      * @uses BBP_Topics_Widget::get_field_name() To output the field name
    930856     */
    931857    public function form( $instance = array() ) {
    … …  
    968894     *
    969895     * @param $instance Instance
    970      * @uses bbp_parse_args() To merge widget options into defaults
    971896     */
    972897    public function parse_settings( $instance = array() ) {
    … …  
    988913 *
    989914 * @since 2.3.0 bbPress (r4509)
    990  *
    991  * @uses WP_Widget
    992915 */
    993916class BBP_Stats_Widget extends WP_Widget {
    … …  
    999922     *
    1000923     * @since 2.3.0 bbPress (r4509)
    1001      *
    1002      * @uses  apply_filters() Calls 'bbp_stats_widget_options' with the
    1003      *        widget options
    1004924     */
    1005925    public function __construct() {
    … …  
    1016936     *
    1017937     * @since 2.3.0 bbPress (r4509)
    1018      *
    1019      * @uses register_widget()
    1020938     */
    1021939    public static function register_widget() {
    … …  
    1030948     * @param array $args     Arguments
    1031949     * @param array $instance Instance
    1032      *
    1033      * @uses apply_filters() Calls 'bbp_stats_widget_title' with the title
    1034      * @uses bbp_get_template_part() To get the content-forum-statistics template
    1035950     */
    1036951    public function widget( $args = array(), $instance = array() ) {
    … …  
    11021017     *
    11031018     * @param $instance Instance
    1104      * @uses bbp_parse_args() To merge widget settings into defaults
    11051019     */
    11061020    public function parse_settings( $instance = array() ) {
    … …  
    11171031 *
    11181032 * @since 2.0.0 bbPress (r2653)
    1119  *
    1120  * @uses WP_Widget
    11211033 */
    11221034class BBP_Replies_Widget extends WP_Widget {
    … …  
    11281040     *
    11291041     * @since 2.0.0 bbPress (r2653)
    1130      *
    1131      * @uses apply_filters() Calls 'bbp_replies_widget_options' with the
    1132      *                        widget options
    11331042     */
    11341043    public function __construct() {
    … …  
    11451054     *
    11461055     * @since 2.0.0 bbPress (r3389)
    1147      *
    1148      * @uses register_widget()
    11491056     */
    11501057    public static function register_widget() {
    … …  
    11591066     * @param array $args
    11601067     * @param array $instance
    1161      * @uses apply_filters() Calls 'bbp_reply_widget_title' with the title
    1162      * @uses bbp_get_reply_author_link() To get the reply author link
    1163      * @uses bbp_get_reply_id() To get the reply id
    1164      * @uses bbp_get_reply_url() To get the reply url
    1165      * @uses bbp_get_reply_excerpt() To get the reply excerpt
    1166      * @uses bbp_get_reply_topic_title() To get the reply topic title
    1167      * @uses get_the_date() To get the date of the reply
    1168      * @uses get_the_time() To get the time of the reply
    11691068     */
    11701069    public function widget( $args, $instance ) {
    … …  
    12961195     *
    12971196     * @param $instance Instance
    1298      * @uses BBP_Replies_Widget::get_field_id() To output the field id
    1299      * @uses BBP_Replies_Widget::get_field_name() To output the field name
    13001197     */
    13011198    public function form( $instance = array() ) {
    … …  
    13181215     *
    13191216     * @param $instance Instance
    1320      * @uses bbp_parse_args() To merge widget settings into defaults
    13211217     */
    13221218    public function parse_settings( $instance = array() ) {
Note: See TracChangeset for help on using the changeset viewer.