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/shortcodes.php

    r6438 r6573  
    3333     * @since 2.0.0 bbPress (r3031)
    3434     *
    35      * @uses setup_globals()
    36      * @uses add_shortcodes()
    3735     */
    3836    public function __construct() {
     
    4745     *
    4846     * @access private
    49      *
    50      * @uses apply_filters()
    5147     */
    5248    private function setup_globals() {
     
    10298     *
    10399     * @since 2.0.0 bbPress (r3031)
    104      *
    105      * @uses add_shortcode()
    106      * @uses do_action()
    107100     */
    108101    private function add_shortcodes() {
     
    149142     *
    150143     * @param string $query_name
    151      *
    152      * @uses bbp_set_query_name()
    153      * @uses ob_start()
    154144     */
    155145    private function start( $query_name = '' ) {
     
    167157     * @since 2.0.0 bbPress (r3079)
    168158     *
    169      * @uses BBP_Shortcodes::unset_globals() Cleans up global values
    170159     * @return string Contents of output buffer.
    171160     */
     
    196185     * @since 2.0.0 bbPress (r3031)
    197186     *
    198      * @uses bbp_has_forums()
    199      * @uses get_template_part()
    200187     * @return string
    201188     */
     
    222209     * @param array $attr
    223210     * @param string $content
    224      * @uses get_template_part()
    225      * @uses bbp_single_forum_description()
    226211     * @return string
    227212     */
     
    262247     *
    263248     * @since 2.1.0 bbPress (r3566)
    264      *
    265      * @uses get_template_part()
    266249     */
    267250    public function display_forum_form() {
     
    285268     * @since 2.0.0 bbPress (r3031)
    286269     *
    287      * @uses get_template_part()
    288270     * @return string
    289271     */
     
    316298     * @param array $attr
    317299     * @param string $content
    318      * @uses get_template_part()
    319300     * @return string
    320301     */
     
    382363     * @param array $attr
    383364     * @param string $content
    384      * @uses get_template_part()
    385365     * @return string
    386366     */
     
    437417     * @param array $attr
    438418     * @param string $content
    439      * @uses get_template_part()
    440419     * @return string
    441420     */
     
    496475     *
    497476     * @since 2.0.0 bbPress (r3031)
    498      *
    499      * @uses get_template_part()
    500477     */
    501478    public function display_reply_form() {
     
    549526     * @param array $attr
    550527     * @param string $content
    551      * @uses get_template_part()
    552528     * @return string
    553529     */
     
    586562     * @since 2.0.0 bbPress (r3346)
    587563     *
    588      * @uses get_template_part()
    589564     * @return string
    590565     */
     
    614589     * @param array $attr
    615590     * @param string $content
    616      * @uses get_template_part()
    617      * @uses bbp_single_forum_description()
    618591     * @return string
    619592     */
     
    654627     *
    655628     * @since 2.3.0 bbPress (r4585)
    656      *
    657      * @uses get_template_part()
    658629     */
    659630    public function display_search_form() {
     
    682653     * @param array $attr
    683654     * @param string $content
    684      * @uses bbp_search_query()
    685      * @uses get_template_part()
    686655     */
    687656    public function display_search( $attr, $content = '' ) {
Note: See TracChangeset for help on using the changeset viewer.