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

    r6566 r6573  
    8282     *
    8383     * @since 2.0.0 bbPress (r2515)
    84      *
    85      * @uses BBP_Admin::setup_globals() Setup the globals needed
    86      * @uses BBP_Admin::includes() Include the required files
    87      * @uses BBP_Admin::setup_actions() Setup the hooks and actions
    8884     */
    8985    public function __construct() {
    … …  
    148144     *
    149145     * @access private
    150      *
    151      * @uses add_action() To add various actions
    152      * @uses add_filter() To add various filters
    153146     */
    154147    private function setup_actions() {
    … …  
    203196     *
    204197     * @since 2.0.0 bbPress (r2646)
    205      *
    206      * @uses add_management_page() To add the Recount page in Tools section
    207      * @uses add_options_page() To add the Forums settings page in Settings
    208      *                           section
    209198     */
    210199    public function admin_menus() {
    … …  
    299288     *
    300289     * @since 2.1.0 bbPress (r3689)
    301      *
    302      * @uses add_submenu_page() To add the Update Forums page in Updates
    303290     */
    304291    public function network_admin_menus() {
    … …  
    339326     * @since 2.0.0 bbPress (r2737)
    340327     *
    341      * @uses add_settings_section() To add our own settings section
    342      * @uses add_settings_field() To add various settings fields
    343      * @uses register_setting() To register various settings
    344328     * @todo Put fields into multidimensional array
    345329     */
    … …  
    402386     * @param int $user_id User id
    403387     * @param array $args Arguments
    404      * @uses get_post() To get the post
    405      * @uses apply_filters() Calls 'bbp_map_meta_caps' with caps, cap, user id and
    406      *                        args
     388     *
    407389     * @return array Actual capabilities for meta capability
    408390     */
    … …  
    466448     *
    467449     * @since 2.0.0 bbPress (r2737)
    468      *
    469      * @uses apply_filters() Calls 'bbp_importer_path' filter to allow plugins
    470      *                        to customize the importer script locations.
    471450     */
    472451    public function register_importers() {
    … …  
    505484     *
    506485     * @since 2.0.0 bbPress (r2743)
    507      *
    508      * @uses current_user_can() To check notice should be displayed.
    509486     */
    510487    public function activation_notice() {
    … …  
    632609     *
    633610     * @since 2.0.0 bbPress (r2464)
    634      *
    635      * @uses remove_submenu_page() To remove menu items with alternate navigation
    636611     */
    637612    public function admin_head() {
    … …  
    655630     *
    656631     * @since 2.0.0 bbPress (r2521)
    657      *
    658      * @uses wp_admin_css_color() To register the color scheme
    659632     */
    660633    public function register_admin_style() {
    … …  
    707680     *
    708681     * @since 2.2.0 bbPress (r4261)
    709      *
    710      * @uses get_posts()
    711      * @uses bbp_get_topic_post_type()
    712      * @uses bbp_get_topic_id()
    713      * @uses bbp_get_topic_title()
    714682     */
    715683    public function suggest_topic() {
    … …  
    1005973     *
    1006974     * @since 2.1.0 bbPress (r3689)
    1007      *
    1008      * @uses get_blog_option()
    1009      * @uses wp_remote_get()
    1010975     */
    1011976    public static function update_screen() {
    … …  
    10501015     *
    10511016     * @since 2.1.0 bbPress (r3689)
    1052      *
    1053      * @uses get_blog_option()
    1054      * @uses wp_remote_get()
    10551017     */
    10561018    public static function network_update_screen() {
    … …  
    11731135 *
    11741136 * @since 2.0.0 bbPress (r2596)
    1175  *
    1176  * @uses BBP_Admin
    11771137 */
    11781138function bbp_admin() {
Note: See TracChangeset for help on using the changeset viewer.