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.

Built from https://develop.svn.wordpress.org/trunk@41162


git-svn-id: http://core.svn.wordpress.org/trunk@41002 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes
2017-07-27 00:41:44 +00:00
parent 1a28ec87e1
commit 0860bb2771
136 changed files with 3 additions and 1907 deletions

View File

@@ -17,7 +17,6 @@ class WP_Image_Editor_GD extends WP_Image_Editor {
/**
* GD Resource.
*
* @access protected
* @var resource
*/
protected $image;
@@ -35,7 +34,6 @@ class WP_Image_Editor_GD extends WP_Image_Editor {
* @since 3.5.0
*
* @static
* @access public
*
* @param array $args
* @return bool
@@ -61,7 +59,6 @@ class WP_Image_Editor_GD extends WP_Image_Editor {
* @since 3.5.0
*
* @static
* @access public
*
* @param string $mime_type
* @return bool
@@ -84,7 +81,6 @@ class WP_Image_Editor_GD extends WP_Image_Editor {
* Loads image from $this->file into new GD Resource.
*
* @since 3.5.0
* @access public
*
* @return bool|WP_Error True if loaded successfully; WP_Error on failure.
*/
@@ -122,7 +118,6 @@ class WP_Image_Editor_GD extends WP_Image_Editor {
* Sets or updates current image size.
*
* @since 3.5.0
* @access protected
*
* @param int $width
* @param int $height
@@ -147,7 +142,6 @@ class WP_Image_Editor_GD extends WP_Image_Editor {
* maintain aspect ratio according to the provided dimension.
*
* @since 3.5.0
* @access public
*
* @param int|null $max_w Image width.
* @param int|null $max_h Image height.
@@ -200,7 +194,6 @@ class WP_Image_Editor_GD extends WP_Image_Editor {
* Resize multiple images from a single source.
*
* @since 3.5.0
* @access public
*
* @param array $sizes {
* An array of image size arrays. Default sizes are 'small', 'medium', 'medium_large', 'large'.
@@ -263,7 +256,6 @@ class WP_Image_Editor_GD extends WP_Image_Editor {
* Crops Image.
*
* @since 3.5.0
* @access public
*
* @param int $src_x The start x position to crop from.
* @param int $src_y The start y position to crop from.
@@ -309,7 +301,6 @@ class WP_Image_Editor_GD extends WP_Image_Editor {
* Ported from image-edit.php
*
* @since 3.5.0
* @access public
*
* @param float $angle
* @return true|WP_Error
@@ -335,7 +326,6 @@ class WP_Image_Editor_GD extends WP_Image_Editor {
* Flips current image.
*
* @since 3.5.0
* @access public
*
* @param bool $horz Flip along Horizontal Axis
* @param bool $vert Flip along Vertical Axis
@@ -365,7 +355,6 @@ class WP_Image_Editor_GD extends WP_Image_Editor {
* Saves current in-memory image to file.
*
* @since 3.5.0
* @access public
*
* @param string|null $filename
* @param string|null $mime_type
@@ -439,7 +428,6 @@ class WP_Image_Editor_GD extends WP_Image_Editor {
* Returns stream of current image.
*
* @since 3.5.0
* @access public
*
* @param string $mime_type
* @return bool
@@ -464,7 +452,6 @@ class WP_Image_Editor_GD extends 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