X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/9e77185fafaf4e60e2b73821e0e4b9b1a11fb85f..5d244c8fd9a27c9f89dd08da2af6fbc67d4fce63:/wp-admin/includes/template.php
diff --git a/wp-admin/includes/template.php b/wp-admin/includes/template.php
index 30dcf0fc..1087837c 100644
--- a/wp-admin/includes/template.php
+++ b/wp-admin/includes/template.php
@@ -13,12 +13,13 @@
//
/**
- * Walker to output an unordered list of category checkbox elements.
+ * Walker to output an unordered list of category checkbox input elements.
+ *
+ * @since 2.5.1
*
* @see Walker
* @see wp_category_checklist()
* @see wp_terms_checklist()
- * @since 2.5.1
*/
class Walker_Category_Checklist extends Walker {
public $tree_type = 'category';
@@ -112,12 +113,15 @@ class Walker_Category_Checklist extends Walker {
}
/**
- * Output an unordered list of checkbox elements labelled
+ * Output an unordered list of checkbox input elements labelled
* with category names.
*
- * @see wp_terms_checklist()
* @since 2.5.1
*
+ * @todo Properly document optional arguments as such.
+ *
+ * @see wp_terms_checklist()
+ *
* @param int $post_id Mark categories associated with this post as checked. $selected_cats must not be an array.
* @param int $descendants_and_self ID of the category to output along with its descendents.
* @param bool|array $selected_cats List of categories to mark as checked.
@@ -137,13 +141,16 @@ function wp_category_checklist( $post_id = 0, $descendants_and_self = 0, $select
}
/**
- * Output an unordered list of checkbox elements labelled
- * with term names. Taxonomy independent version of wp_category_checklist().
+ * Output an unordered list of checkbox input elements labelled with term names.
+ *
+ * Taxonomy independent version of {@see wp_category_checklist()}.
*
* @since 3.0.0
*
- * @param int $post_id
- * @param array $args
+ * @todo Properly document optional default arguments.
+ *
+ * @param int $post_id Post ID.
+ * @param array $args Arguments to form the terms checklist.
*/
function wp_terms_checklist( $post_id = 0, $args = array() ) {
$defaults = array(
@@ -236,7 +243,7 @@ function wp_terms_checklist( $post_id = 0, $args = array() ) {
* Retrieve a list of the most popular terms from the specified taxonomy.
*
* If the $echo argument is true then the elements for a list of checkbox
- * elements labelled with the names of the selected terms is output.
+ * `` elements labelled with the names of the selected terms is output.
* If the $post_ID global isn't empty then the terms associated with that
* post will be marked as checked.
*
@@ -289,7 +296,7 @@ function wp_popular_terms_checklist( $taxonomy, $default = 0, $number = 10, $ech
*
* @since 2.5.1
*
- * @param unknown_type $link_id
+ * @param int $link_id
*/
function wp_link_category_checklist( $link_id = 0 ) {
$default = 1;
@@ -324,7 +331,7 @@ function wp_link_category_checklist( $link_id = 0 ) {
*
* @since 2.7.0
*
- * @param unknown_type $post
+ * @param WP_Post $post
*/
function get_inline_data($post) {
$post_type_object = get_post_type_object($post->post_type);
@@ -396,9 +403,10 @@ function get_inline_data($post) {
*
* @since 2.7.0
*
- * @param unknown_type $position
- * @param unknown_type $checkbox
- * @param unknown_type $mode
+ * @param int $position
+ * @param bool $checkbox
+ * @param string $mode
+ * @param bool $table_row
*/
function wp_comment_reply($position = '1', $checkbox = false, $mode = 'single', $table_row = true) {
@@ -518,7 +526,7 @@ function wp_comment_trashnotice() {
*
* @since 1.2.0
*
- * @param unknown_type $meta
+ * @param array $meta
*/
function list_meta( $meta ) {
// Exit if no meta
@@ -561,9 +569,9 @@ function list_meta( $meta ) {
*
* @since 2.5.0
*
- * @param unknown_type $entry
- * @param unknown_type $count
- * @return unknown
+ * @param array $entry
+ * @param int $count
+ * @return string
*/
function _list_meta_row( $entry, &$count ) {
static $update_nonce = false;
@@ -699,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 ) {
@@ -781,7 +789,7 @@ function touch_time( $edit = 1, $for_post = 1, $tab_index = 0, $multi = 0 ) {
}
/**
- * Print out