Minor WP_Image_Editor documentation fixes. See #6821.

git-svn-id: http://core.svn.wordpress.org/trunk@22511 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Jon Cave 2012-11-09 20:10:33 +00:00
parent d3463e4aea
commit e860d3eb24
1 changed files with 5 additions and 6 deletions

View File

@ -30,7 +30,7 @@ abstract class WP_Image_Editor {
* *
* @param string $path Path to File to Load * @param string $path Path to File to Load
* @param array $required_methods Methods to require in implementation * @param array $required_methods Methods to require in implementation
* @return WP_Image_Editor|WP_Error|boolean * @return WP_Image_Editor|WP_Error
*/ */
public final static function get_instance( $path = null, $required_methods = null ) { public final static function get_instance( $path = null, $required_methods = null ) {
$implementation = apply_filters( 'wp_image_editor_class', self::choose_implementation( $required_methods ), $path ); $implementation = apply_filters( 'wp_image_editor_class', self::choose_implementation( $required_methods ), $path );
@ -54,8 +54,7 @@ abstract class WP_Image_Editor {
* @since 3.5.0 * @since 3.5.0
* @access private * @access private
* *
* @param $required_methods Array String array of all methods required for implementation returned. * @param array $required_methods String array of all methods required for implementation returned.
*
* @return string|bool Class name for the first editor that claims to support the request. False if no editor claims to support the request. * @return string|bool Class name for the first editor that claims to support the request. False if no editor claims to support the request.
*/ */
private final static function choose_implementation( $required_methods = null ) { private final static function choose_implementation( $required_methods = null ) {
@ -103,7 +102,7 @@ abstract class WP_Image_Editor {
* @access public * @access public
* @abstract * @abstract
* *
* @param $args array * @param array $args
* @return boolean * @return boolean
*/ */
public static function test( $args = null ) { public static function test( $args = null ) {
@ -181,7 +180,7 @@ abstract class WP_Image_Editor {
* @access protected * @access protected
* *
* @param string $filename * @param string $filename
* @param type $mime_type * @param string $mime_type
* @return array { filename|null, extension, mime-type } * @return array { filename|null, extension, mime-type }
*/ */
protected function get_output_format( $filename = null, $mime_type = null ) { protected function get_output_format( $filename = null, $mime_type = null ) {
@ -359,4 +358,4 @@ abstract class WP_Image_Editor {
return $extensions[0]; return $extensions[0];
} }
} }