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/extend/buddypress/groups.php

    r6498 r6573  
    314314         *
    315315         * @param object $group (the group to edit if in Group Admin UI)
    316          * @uses is_admin() To check if we're in the Group Admin UI
    317          * @uses bbp_get_template_part()
    318316         */
    319317        public function edit_screen( $group = false ) {
    … …  
    380378         *
    381379         * @param int $group_id (to handle Group Admin UI hook bp_group_admin_edit_after )
    382          * @uses bbp_new_forum_handler() To check for forum creation
    383          * @uses bbp_edit_forum_handler() To check for forum edit
    384380         */
    385381        public function edit_screen_save( $group_id = 0 ) {
    … …  
    489485         *
    490486         * @since 2.3.0 bbPress (r4814)
    491          *
    492          * @uses add_meta_box
    493          * @uses BBP_Forums_Group_Extension::group_admin_ui_display_metabox() To display the edit screen
    494487         */
    495488        public function group_admin_ui_edit_screen() {
    … …  
    510503         *
    511504         * @param object $item (group object)
    512          * @uses add_meta_box
    513          * @uses BBP_Forums_Group_Extension::edit_screen() To get the html
    514505         */
    515506        public function group_admin_ui_display_metabox( $item ) {
    … …  
    660651         *
    661652         * @param type $forum_args
    662          * @uses bbp_get_forum_id()
    663          * @uses bp_get_current_group_id()
    664          * @uses bbp_add_forum_id_to_group()
    665          * @uses bbp_add_group_id_to_forum()
    666653         * @return if no forum_id is available
    667654         */
    … …  
    687674         *
    688675         * @param type $forum_args
    689          * @uses bbp_get_forum_id()
    690          * @uses bp_get_current_group_id()
    691          * @uses bbp_add_forum_id_to_group()
    692          * @uses bbp_add_group_id_to_forum()
    693676         * @return if no forum_id is available
    694677         */
    … …  
    714697         *
    715698         * @param int $group_id The group ID
    716          * @uses bbp_get_group_forum_ids()
    717          * @uses BBP_Forums_Group_Extension::remove_forum()
    718699         */
    719700        public function disconnect_forum_from_group( $group_id = 0 ) {
    … …  
    794775         * @param int $group_id The group to toggle
    795776         * @param bool $enabled True for on, false for off
    796          * @uses groups_get_group() To get the group to toggle
    797777         * @return False if group is not found, otherwise return the group
    798778         */
    … …  
    834814         *
    835815         * @since 2.1.0 bbPress (r3653)
    836          *
    837          * @uses bp_get_current_group_id()
    838          * @uses bbp_get_group_forum_ids()
    839          * @uses bbp_has_forums()
    840          * @uses bbp_get_template_part()
    841816         */
    842817        public function display_forums( $offset = 0 ) {
    … …  
    11591134         *
    11601135         * @since 2.1.0 bbPress (r3653)
    1161          *
    1162          * @uses groups_get_current_group()
    1163          * @uses bp_is_group_admin_screen()
    1164          * @uses trailingslashit()
    1165          * @uses bp_get_root_domain()
    1166          * @uses bp_get_groups_root_slug()
    11671136         */
    11681137        public function edit_redirect_to( $redirect_url = '' ) {
    … …  
    11861155         * @since 2.1.0 bbPress (r3746)
    11871156         */
    1188 
    11891157        public function forum_parent() {
    11901158        ?>
    … …  
    11991167         *
    12001168         * @since 2.1.0 bbPress (r3746)
    1201          *
    1202          * @uses bbp_get_group_forum_ids() to get BuddyPress group forums
    1203          * @uses bbp_dropdown() To show a dropdown of the forums for forum parent
    1204          *
    12051169         */
    12061170        public function topic_parent() {
    … …  
    12221186         *
    12231187         * @param bool $retval Are we allowed to view the reply form?
    1224          * @uses bp_is_group() To determine if we're on a group page
    1225          * @uses is_user_logged_in() To determine if a user is logged in.
    1226          * @uses bbp_is_user_keymaster() Is the current user a keymaster?
    1227          * @uses bbp_group_is_member() Is the current user a member of the group?
    1228          * @uses bbp_group_is_user_banned() Is the current user banned from the group?
    12291188         *
    12301189         * @return bool
    … …  
    12891248         *
    12901249         * @param int $post_id
    1291          * @uses get_post()
    1292          * @uses bbp_is_reply()
    1293          * @uses bbp_get_reply_topic_id()
    1294          * @uses bbp_get_reply_forum_id()
    1295          * @uses bbp_is_topic()
    1296          * @uses bbp_get_topic_forum_id()
    1297          * @uses bbp_is_forum()
    1298          * @uses get_post_field()
    1299          * @uses bbp_get_forum_group_ids()
    1300          * @uses groups_get_group()
    1301          * @uses bp_get_group_admin_permalink()
    1302          * @uses bp_get_group_permalink()
    13031250         * @return Bail early if not a group forum post
    13041251         * @return string
    … …  
    13611308         * @param string $url
    13621309         * @param int $forum_id
    1363          * @uses maybe_map_permalink_to_group()
    13641310         * @return string
    13651311         */
    … …  
    13751321         * @param string $url
    13761322         * @param int $topic_id
    1377          * @uses maybe_map_permalink_to_group()
    13781323         * @return string
    13791324         */
    … …  
    13891334         * @param string $url
    13901335         * @param int $reply_id
    1391          * @uses maybe_map_permalink_to_group()
    13921336         * @return string
    13931337         */
    … …  
    14031347         * @param string $url
    14041348         * @param int $reply_id
    1405          * @uses maybe_map_permalink_to_group()
    14061349         * @return string
    14071350         */
    … …  
    14241367         * @param obj $post
    14251368         * @param boolean $leavename
    1426          * @uses maybe_map_permalink_to_group()
    14271369         * @return string
    14281370         */
    … …  
    14391381         * @param int $post_id
    14401382         * @param $sample
    1441          * @uses maybe_map_permalink_to_group()
    14421383         * @return string
    14431384         */
    … …  
    14551396         * @param $leavename
    14561397         * @param $sample
    1457          * @uses maybe_map_permalink_to_group()
    14581398         * @return string
    14591399         */
    … …  
    14681408         *
    14691409         * @param array $args
    1470          * @uses bbp_get_forum_id()
    1471          * @uses maybe_map_permalink_to_group
    14721410         * @return array
    14731411         */
    … …  
    14901428         *
    14911429         * @param array $args
    1492          * @uses bbp_get_topic_id()
    1493          * @uses maybe_map_permalink_to_group
    14941430         * @return array
    14951431         */
    … …  
    15621498         *
    15631499         * @param array $args Arguments from BBP_BuddyPress_Activity::record_activity()
    1564          * @uses groups_get_current_group() To see if we're posting from a BP group
    15651500         *
    15661501         * @return array
Note: See TracChangeset for help on using the changeset viewer.