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/search/template.php

    r6438 r6573  
    1919 *
    2020 * @param array $args All the arguments supported by {@link WP_Query}
    21  * @uses bbp_get_view_all() Are we showing all results?
    22  * @uses bbp_get_public_status_id() To get the public status id
    23  * @uses bbp_get_closed_status_id() To get the closed status id
    24  * @uses bbp_get_spam_status_id() To get the spam status id
    25  * @uses bbp_get_trash_status_id() To get the trash status id
    26  * @uses bbp_get_forum_post_type() To get the forum post type
    27  * @uses bbp_get_topic_post_type() To get the topic post type
    28  * @uses bbp_get_reply_post_type() To get the reply post type
    29  * @uses bbp_get_replies_per_page() To get the replies per page option
    30  * @uses bbp_get_paged() To get the current page value
    31  * @uses bbp_get_search_terms() To get the search terms
    32  * @uses WP_Query To make query and get the search results
    33  * @uses bbp_use_pretty_urls() To check if the site is using pretty URLs
    34  * @uses bbp_get_search_url() To get the forum search url
    35  * @uses paginate_links() To paginate search results
    36  * @uses apply_filters() Calls 'bbp_has_search_results' with
    37  *                        bbPress::search_query::have_posts()
    38  *                        and bbPress::reply_query
    3921 * @return object Multidimensional array of search information
    4022 */
    … …  
    169151 * @since 2.3.0 bbPress (r4579)
    170152 *
    171  * @uses WP_Query bbPress::search_query::have_posts() To check if there are more
    172  *                                                     search results available
    173153 * @return object Search information
    174154 */
    … …  
    191171 * @since 2.3.0 bbPress (r4579)
    192172 *
    193  * @uses WP_Query bbPress::search_query::the_post() To get the current search result
    194173 * @return object Search information
    195174 */
    … …  
    209188 *
    210189 * @since 2.3.0 bbPress (r4579)
    211  *
    212  * @uses bbp_get_search_title()
    213190 */
    214191function bbp_search_title() {
    … …  
    220197     *
    221198     * @since 2.3.0 bbPress (r4579)
    222      *
    223      * @uses bbp_get_search_terms()
    224199     */
    225200    function bbp_get_search_title() {
    … …  
    245220 *
    246221 * @since 2.3.0 bbPress (r4579)
    247  *
    248  * @uses bbp_get_search_url() To get the search url
    249222 */
    250223function bbp_search_url() {
    … …  
    256229     * @since 2.3.0 bbPress (r4579)
    257230     *
    258      * @uses user_trailingslashit() To fix slashes
    259      * @uses trailingslashit() To fix slashes
    260      * @uses bbp_get_forums_url() To get the root forums url
    261      * @uses bbp_get_search_slug() To get the search slug
    262      * @uses add_query_arg() To help make unpretty permalinks
    263231     * @return string Search url
    264232     */
    … …  
    286254 *
    287255 * @since 2.4.0 bbPress (r4928)
    288  *
    289  * @uses bbp_get_search_url() To get the search url
    290256 */
    291257function bbp_search_results_url() {
    … …  
    297263     * @since 2.4.0 bbPress (r4928)
    298264     *
    299      * @uses user_trailingslashit() To fix slashes
    300      * @uses trailingslashit() To fix slashes
    301      * @uses bbp_get_forums_url() To get the root forums url
    302      * @uses bbp_get_search_slug() To get the search slug
    303      * @uses add_query_arg() To help make unpretty permalinks
    304265     * @return string Search url
    305266     */
    … …  
    341302 *
    342303 * @param string $search_terms Optional. Search terms
    343  * @uses bbp_get_search_terms() To get the search terms
    344304 */
    345305function bbp_search_terms( $search_terms = '' ) {
    … …  
    356316     *
    357317     * @param string $passed_terms Optional. Search terms
    358      * @uses sanitize_title() To sanitize the search terms
    359      * @uses get_query_var() To get the search terms from query variable
    360318     * @return bool|string Search terms on success, false on failure
    361319     */
    … …  
    382340 *
    383341 * @since 2.3.0 bbPress (r4579)
    384  *
    385  * @uses bbp_get_search_pagination_count() To get the search result pagination count
    386342 */
    387343function bbp_search_pagination_count() {
    … …  
    394350     * @since 2.3.0 bbPress (r4579)
    395351     *
    396      * @uses bbp_number_format() To format the number value
    397      * @uses apply_filters() Calls 'bbp_get_search_pagination_count' with the
    398      *                        pagination count
    399352     * @return string Search pagination count
    400353     */
    … …  
    435388 *
    436389 * @since 2.3.0 bbPress (r4579)
    437  *
    438  * @uses bbp_get_search_pagination_links() To get the search pagination links
    439390 */
    440391function bbp_search_pagination_links() {
    … …  
    447398     * @since 2.3.0 bbPress (r4579)
    448399     *
    449      * @uses apply_filters() Calls 'bbp_get_search_pagination_links' with the
    450      *                        pagination links
    451400     * @return string Search pagination links
    452401     */
Note: See TracChangeset for help on using the changeset viewer.