Docs: Remove @access notations from method DocBlocks in wp-includes/* classes.

Prior to about 2013, many class methods lacked even access modifiers which made the `@access` notations that much more useful. Now that we've gotten to a point where the codebase is more mature from a maintenance perspective and we can finally remove these notations. Notable exceptions to this change include standalone functions notated as private as well as some classes still considered to represent "private" APIs.

See #41452.


git-svn-id: https://develop.svn.wordpress.org/trunk@41162 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes
2017-07-27 00:40:27 +00:00
parent 829139ba1a
commit b4d81bd654
135 changed files with 2 additions and 1906 deletions

View File

@@ -35,7 +35,6 @@ abstract class WP_Image_Editor {
* @since 3.5.0
*
* @static
* @access public
* @abstract
*
* @param array $args
@@ -52,7 +51,6 @@ abstract class WP_Image_Editor {
* @since 3.5.0
*
* @static
* @access public
* @abstract
*
* @param string $mime_type
@@ -66,7 +64,6 @@ abstract class WP_Image_Editor {
* Loads image from $this->file into editor.
*
* @since 3.5.0
* @access public
* @abstract
*
* @return bool|WP_Error True if loaded; WP_Error on failure.
@@ -77,7 +74,6 @@ abstract class WP_Image_Editor {
* Saves current image to file.
*
* @since 3.5.0
* @access public
* @abstract
*
* @param string $destfilename
@@ -94,7 +90,6 @@ abstract class WP_Image_Editor {
* maintain aspect ratio according to the provided dimension.
*
* @since 3.5.0
* @access public
* @abstract
*
* @param int|null $max_w Image width.
@@ -108,7 +103,6 @@ abstract class WP_Image_Editor {
* Resize multiple images from a single source.
*
* @since 3.5.0
* @access public
* @abstract
*
* @param array $sizes {
@@ -128,7 +122,6 @@ abstract class WP_Image_Editor {
* Crops Image.
*
* @since 3.5.0
* @access public
* @abstract
*
* @param int $src_x The start x position to crop from.
@@ -146,7 +139,6 @@ abstract class WP_Image_Editor {
* Rotates current image counter-clockwise by $angle.
*
* @since 3.5.0
* @access public
* @abstract
*
* @param float $angle
@@ -158,7 +150,6 @@ abstract class WP_Image_Editor {
* Flips current image.
*
* @since 3.5.0
* @access public
* @abstract
*
* @param bool $horz Flip along Horizontal Axis
@@ -171,7 +162,6 @@ abstract class WP_Image_Editor {
* Streams current image to browser.
*
* @since 3.5.0
* @access public
* @abstract
*
* @param string $mime_type
@@ -183,7 +173,6 @@ abstract class WP_Image_Editor {
* Gets dimensions of image.
*
* @since 3.5.0
* @access public
*
* @return array {'width'=>int, 'height'=>int}
*/
@@ -195,7 +184,6 @@ abstract class WP_Image_Editor {
* Sets current image size.
*
* @since 3.5.0
* @access protected
*
* @param int $width
* @param int $height
@@ -213,7 +201,6 @@ abstract class WP_Image_Editor {
* Gets the Image Compression quality on a 1-100% scale.
*
* @since 4.0.0
* @access public
*
* @return int $quality Compression Quality. Range: [1,100]
*/
@@ -229,7 +216,6 @@ abstract class WP_Image_Editor {
* Sets Image Compression quality on a 1-100% scale.
*
* @since 3.5.0
* @access public
*
* @param int $quality Compression Quality. Range: [1,100]
* @return true|WP_Error True if set successfully; WP_Error on failure.
@@ -298,7 +284,6 @@ abstract class WP_Image_Editor {
* Provides corrected filename only if filename is provided.
*
* @since 3.5.0
* @access protected
*
* @param string $filename
* @param string $mime_type
@@ -359,7 +344,6 @@ abstract class WP_Image_Editor {
* Builds an output filename based on current file, and adding proper suffix
*
* @since 3.5.0
* @access public
*
* @param string $suffix
* @param string $dest_path
@@ -387,7 +371,6 @@ abstract class WP_Image_Editor {
* Builds and returns proper suffix for file based on height and width.
*
* @since 3.5.0
* @access public
*
* @return false|string suffix
*/
@@ -402,7 +385,6 @@ abstract class WP_Image_Editor {
* Either calls editor's save function or handles file as a stream.
*
* @since 3.5.0
* @access protected
*
* @param string|stream $filename
* @param callable $function
@@ -445,7 +427,6 @@ abstract class WP_Image_Editor {
* @since 3.5.0
*
* @static
* @access protected
*
* @param string $extension
* @return string|false
@@ -473,7 +454,6 @@ abstract class WP_Image_Editor {
* @since 3.5.0
*
* @static
* @access protected
*
* @param string $mime_type
* @return string|false