Fix some `@param` docs that have chars too close them.

Add `@property` annotations to `WP_User` and `WP_Post`.
Remove erroneous `@param`s from image editor class methods.
Officially add the property `$_column_headers` to `WP_List_Table`.	

See #30799.


git-svn-id: https://develop.svn.wordpress.org/trunk@31127 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Scott Taylor 2015-01-10 06:56:51 +00:00
parent 349e5cb318
commit 979ba60a57
6 changed files with 24 additions and 4 deletions

View File

@ -73,6 +73,13 @@ class WP_List_Table {
*/
protected $modes = array();
/**
* Stores the value returned by ->get_column_info()
*
* @var array
*/
protected $_column_headers;
/**
* Constructor.
*

View File

@ -415,6 +415,17 @@ class WP_Role {
* @since 2.0.0
* @package WordPress
* @subpackage User
*
* @property string $display_name
* @property string $nickname
* @property string $user_description
* @property string $user_email
* @property string $user_firstname
* @property string $user_lastname
* @property string $user_nicename
* @property string $user_pass
* @property string $user_registered
* @property string $user_url
*/
class WP_User {
/**
@ -492,7 +503,6 @@ class WP_User {
* @param int|string|stdClass|WP_User $id User's ID, a WP_User object, or a user object from the DB.
* @param string $name Optional. User's username
* @param int $blog_id Optional Blog ID, defaults to current blog.
* @return WP_User
*/
public function __construct( $id = 0, $name = '', $blog_id = '' ) {
if ( ! isset( self::$back_compat_keys ) ) {

View File

@ -329,7 +329,6 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor {
* @since 3.5.0
* @access public
*
* @param string|int $src The source file or Attachment ID.
* @param int $src_x The start x position to crop from.
* @param int $src_y The start y position to crop from.
* @param int $src_w The width to crop.

View File

@ -125,7 +125,6 @@ abstract class WP_Image_Editor {
* @access public
* @abstract
*
* @param string|int $src The source file or Attachment ID.
* @param int $src_x The start x position to crop from.
* @param int $src_y The start y position to crop from.
* @param int $src_w The width to crop.

View File

@ -3522,7 +3522,7 @@ function wp_pre_kses_less_than_callback( $matches ) {
* @link http://www.php.net/sprintf
*
* @param string $pattern The string which formatted args are inserted.
* @param mixed $args,... Arguments to be formatted into the $pattern string.
* @param mixed $args ,... Arguments to be formatted into the $pattern string.
* @return string The formatted string.
*/
function wp_sprintf( $pattern ) {

View File

@ -455,6 +455,11 @@ function get_post( $post = null, $output = OBJECT, $filter = 'raw' ) {
*
* @since 3.5.0
*
* @property-read array $ancestors
* @property-read string $page_template
* @property-read int $post_category
* @property-read string $tag_input
*
*/
final class WP_Post {