Changeset 14634

Timestamp:

05/14/2010 03:47:14 PM (15 years ago)

Author:

westi

Message:

Add phpDoc for convert_to_screen() and get_column_headers().

File:

• trunk/wp-admin/includes/template.php (modified) (2 diffs)

trunk/wp-admin/includes/template.php

@@ -665 +665 @@
 
 /**
- * {@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) {
@@ -3546 +3546 @@
 }
 
-// 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);