Skip to:
Content

bbPress.org


Ignore:
Timestamp:
06/16/2017 09:20:52 PM (9 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/classes.php

    r6384 r6573  
    6767         *  - query: The loop for this component (WP_Query)
    6868         *  - current_id: The current ID of the queried object
    69          * @uses BBP_Component::setup_globals() Setup the globals needed
    70          * @uses BBP_Component::includes() Include the required files
    71          * @uses BBP_Component::setup_actions() Setup the hooks and actions
    7269         */
    7370        public function __construct( $args = array() ) {
    … …  
    8784         *
    8885         * @access private
    89          *
    90          * @uses apply_filters() Calls 'bbp_{@link BBP_Component::name}_id'
    91          * @uses apply_filters() Calls 'bbp_{@link BBP_Component::name}_slug'
    9286         */
    9387        private function setup_globals( $args = array() ) {
    … …  
    10397         *
    10498         * @access private
    105          *
    106          * @uses do_action() Calls 'bbp_{@link BBP_Component::name}includes'
    10799         */
    108100        private function includes() {
    … …  
    116108         *
    117109         * @access private
    118          *
    119          * @uses add_action() To add various actions
    120          * @uses do_action() Calls
    121          *                    'bbp_{@link BBP_Component::name}setup_actions'
    122110         */
    123111        private function setup_actions() {
    … …  
    135123         *
    136124         * @since 2.0.0 bbPress (r2700)
    137          *
    138          * @uses do_action() Calls 'bbp_{@link BBP_Component::name}_register_post_types'
    139125         */
    140126        public function register_post_types() {
    … …  
    146132         *
    147133         * @since 2.0.0 bbPress (r2700)
    148          *
    149          * @uses do_action() Calls 'bbp_{@link BBP_Component::name}_register_taxonomies'
    150134         */
    151135        public function register_taxonomies() {
    … …  
    157141         *
    158142         * @since 2.0.0 bbPress (r2700)
    159          *
    160          * @uses do_action() Calls 'bbp_{@link BBP_Component::name}_add_rewrite_tags'
    161143         */
    162144        public function add_rewrite_tags() {
    … …  
    168150         *
    169151         * @since 2.0.0 bbPress (r2700)
    170          *
    171          * @uses do_action() Calls 'bbp_{@link BBP_Component::name}_generate_rewrite_rules'
    172152         */
    173153        public function generate_rewrite_rules( $wp_rewrite ) {
    … …  
    185165 *
    186166 * @since 2.0.0 bbPress (r2746)
    187  *
    188  * @uses Walker
    189167 */
    190168class BBP_Walker_Dropdown extends Walker {
    … …  
    235213         *                       selected HTML attribute for option element.
    236214         * @param int    $current_object_id
    237          *
    238          * @uses bbp_is_forum_category() To check if the forum is a category
    239          * @uses current_user_can() To check if the current user can post in
    240          *                           closed forums
    241          * @uses bbp_is_forum_closed() To check if the forum is closed
    242          * @uses apply_filters() Calls 'bbp_walker_dropdown_post_title' with the
    243          *                        title, output, post, depth and args
    244215         */
    245216        public function start_el( &$output, $object, $depth = 0, $args = array(), $current_object_id = 0 ) {
    … …  
    446417 *
    447418 * @since 2.6.0 bbPress (r5389)
    448  *
    449  * @uses Walker
    450419 */
    451420class BBP_Walker_Reply_Dropdown extends Walker {
    … …  
    500469         *
    501470         * @param int    $current_object_id Not Used
    502          *
    503          * @uses bbp_is_forum_category() To check if the forum is a category
    504          * @uses current_user_can() To check if the current user can post in
    505          *                           closed forums
    506          * @uses bbp_is_forum_closed() To check if the forum is closed
    507          * @uses apply_filters() Calls 'bbp_walker_dropdown_post_title' with the
    508          *                        title, output, post, depth and args
    509471         */
    510472        public function start_el( &$output, $object, $depth = 0, $args = array(), $current_object_id = 0 ) {
Note: See TracChangeset for help on using the changeset viewer.