From 130256271807381523a7a24055a02a7c30eeebda Mon Sep 17 00:00:00 2001 From: Peter Westwood Date: Fri, 14 May 2010 15:47:14 +0000 Subject: [PATCH] Add phpDoc for convert_to_screen() and get_column_headers(). git-svn-id: https://develop.svn.wordpress.org/trunk@14634 602fd350-edb4-49c9-b593-d223f7449a82 --- wp-admin/includes/template.php | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/wp-admin/includes/template.php b/wp-admin/includes/template.php index 594cde9273..92c522e54b 100644 --- a/wp-admin/includes/template.php +++ b/wp-admin/includes/template.php @@ -664,12 +664,12 @@ function wp_manage_pages_columns() { } /** - * {@internal Missing Short Description}} + * Get the column headers for a screen * * @since unknown * - * @param unknown_type $screen - * @return unknown + * @param string|object $screen The screen you want the headers for + * @return array Containing the headers in the format id => UI String */ function get_column_headers($screen) { global $_wp_column_headers; @@ -3545,7 +3545,12 @@ function _post_states($post) { } } -// Convert a screen string to a screen object +/** + * Convert a screen string to a screen object + * + * @param string $screen The name of the screen + * @return object An object containing the safe screen name and id + */ function convert_to_screen( $screen ) { $screen = str_replace('.php', '', $screen); $screen = str_replace('-new', '', $screen);