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/core/functions.php

    r6438 r6573  
    1717 *
    1818 * @since 2.0.0 bbPress (r3468)
    19  *
    20  * @uses bbp_get_version() To get the bbPress version
    2119 */
    2220function bbp_version() {
    … …  
    3836 *
    3937 * @since 2.0.0 bbPress (r3468)
    40  *
    41  * @uses bbp_get_version() To get the bbPress version
    4238 */
    4339function bbp_db_version() {
    … …  
    5955 *
    6056 * @since 2.0.0 bbPress (r3468)
    61  *
    62  * @uses bbp_get_version() To get the current bbPress version
    6357 */
    6458function bbp_db_version_raw() {
    … …  
    180174 * @param string $capability Capability that the current user must have
    181175 *
    182  * @uses sanitize_title() To sanitize the view name
    183  * @uses esc_html() To sanitize the view title
    184176 * @return array The just registered (but processed) view
    185177 */
    … …  
    221213 *
    222214 * @param string $view View name
    223  * @uses sanitize_title() To sanitize the view name
    224215 * @return bool False if the view doesn't exist, true on success
    225216 */
    … …  
    244235 * @param string $view Optional. View id
    245236 * @param mixed $new_args New arguments. See {@link bbp_has_topics()}
    246  * @uses bbp_get_view_id() To get the view id
    247  * @uses bbp_get_view_query_args() To get the view query args
    248  * @uses sanitize_title() To sanitize the view name
    249  * @uses bbp_has_topics() To make the topics query
    250237 * @return bool False if the view doesn't exist, otherwise if topics are there
    251238 */
    … …  
    274261 *
    275262 * @param string $view View name
    276  * @uses bbp_get_view_id() To get the view id
    277263 * @return array Query arguments
    278264 */
    … …  
    296282 *
    297283 * @see WP_Error()
    298  * @uses WP_Error::add();
    299284 *
    300285 * @param string $code Unique code for the error message
    … …  
    312297 *
    313298 * @see WP_Error()
    314  *
    315  * @uses is_wp_error()
    316  * @usese WP_Error::get_error_codes()
    317299 */
    318300function bbp_has_errors() {
    … …  
    372354 * @deprecated 2.6.0 bbp_make_clickable()
    373355 *
    374  * @uses bbp_find_mentions() To get usernames in content areas
    375356 * @return string $content Content filtered for mentions
    376357 */
    … …  
    656637 * @since 2.6.0 bbPress (r5658)
    657638 *
    658  * @uses wp_safe_redirect()
    659  * @uses bbp_get_forums_url()
    660639 * @see  bbp_redirect_to_field()
    661640 *
Note: See TracChangeset for help on using the changeset viewer.