Improve various @param docs for src/wp-admin/*.

See #30224.


git-svn-id: https://develop.svn.wordpress.org/trunk@30680 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Scott Taylor
2014-12-01 00:59:43 +00:00
parent c0045bda84
commit 8a4fa5662b
8 changed files with 33 additions and 23 deletions

View File

@@ -403,7 +403,7 @@ function get_inline_data($post) {
*
* @since 2.7.0
*
* @param string|int $position
* @param int $position
* @param bool $checkbox
* @param string $mode
* @param bool $table_row
@@ -707,10 +707,10 @@ function meta_form( $post = null ) {
*
* @since 0.71
*
* @param int|bool $edit Accepts 1|true for editing the date, 0|false for adding the date.
* @param int|bool $for_post Accepts 1|true for applying the date to a post, 0|false for a comment.
* @param int|bool $tab_index The tabindex attribute to add. Default 0.
* @param int|bool $multi Optional. Whether the additional fields and buttons should be added.
* @param int $edit Accepts 1|true for editing the date, 0|false for adding the date.
* @param int $for_post Accepts 1|true for applying the date to a post, 0|false for a comment.
* @param int $tab_index The tabindex attribute to add. Default 0.
* @param int $multi Optional. Whether the additional fields and buttons should be added.
* Default 0|false.
*/
function touch_time( $edit = 1, $for_post = 1, $tab_index = 0, $multi = 0 ) {
@@ -813,7 +813,7 @@ function page_template_dropdown( $default = '' ) {
* @param int $parent Optional. The parent page ID. Default 0.
* @param int $level Optional. Page depth level. Default 0.
*
* @return void|bool Boolean False if page has no children, otherwise print out html elements
* @return null|false Boolean False if page has no children, otherwise print out html elements
*/
function parent_dropdown( $default = 0, $parent = 0, $level = 0 ) {
global $wpdb;
@@ -992,7 +992,8 @@ function add_meta_box( $id, $title, $callback, $screen = null, $context = 'advan
*
* @since 2.5.0
*
* @param string|object $screen Screen identifier
* @staticvar bool $already_sorted
* @param string|WP_Screen $screen Screen identifier
* @param string $context box context
* @param mixed $object gets passed to the box callback function as first parameter
* @return int number of meta_boxes