Changeset 10825 for trunk/src/bp-core/classes/class-bp-attachment.php

Timestamp:

05/29/2016 06:12:08 PM (7 years ago)

Author:

djpaul

Message:

Remove redundant @uses PHPDoc tag from inline documentation.

Per 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:

• trunk/src/bp-core/classes/class-bp-attachment.php (modified) (7 diffs)

trunk/src/bp-core/classes/class-bp-attachment.php

@@ -51 +51 @@
      * @since 2.3.0
      * @since 2.4.0 Add the $upload_dir_filter_args argument to the $arguments array
-     * @uses                                    sanitize_key()
-     * @uses                                    wp_max_upload_size()
-     * @uses                                    bp_parse_args()
-     * @uses                                    BP_Attachment->set_upload_error_strings()
-     * @uses                                    BP_Attachment->set_upload_dir()
      *
      * @param array|string $args {
@@ -116 +111 @@
      * @since 2.3.0
      *
-     * @uses bp_upload_dir()
      */
     public function set_upload_dir() {
@@ -204 +198 @@
      * @since 2.3.0
      *
-     * @uses   wp_handle_upload()        To upload the file
-     * @uses   add_filter()              To temporarly overrides WordPress uploads data
-     * @uses   remove_filter()           To stop overriding WordPress uploads data
-     * @uses   apply_filters()           Call 'bp_attachment_upload_overrides' to include specific upload overrides
      *
      * @param  array       $file              The appropriate entry the from $_FILES superglobal.
@@ -304 +294 @@
      * @since 2.3.0
      *
-     * @uses get_allowed_mime_types()
      */
     protected function validate_mime_types() {
@@ -355 +344 @@
      * @since 2.4.0 Add the $upload_dir parameter to the method
      *
-     * @uses apply_filters() call 'bp_attachment_upload_dir' to eventually override the upload location
      *       regarding to context
      *
@@ -390 +378 @@
      * @since 2.3.0
      *
-     * @uses wp_mkdir_p()
      */
     public function create_dir() {
@@ -427 +414 @@
      *     @type string $dst_file      Optional. The destination file to write to.
      * }
-     * @uses wp_crop_image()
      *
      * @return string|WP_Error New filepath on success, WP_Error on failure.