Changeset 12687 for trunk/wp-includes/general-template.php

Timestamp:

01/10/2010 03:50:17 PM (15 years ago)

Author:

ryan

Message:

phpdoc updates. Props sirzooro. fixes #11853

File:

• trunk/wp-includes/general-template.php (modified) (11 diffs)

trunk/wp-includes/general-template.php

@@ -1293 +1293 @@
  * @since 1.5.0
  *
- * @param string $d Either 'G', 'U', or php date format defaults to the value specified in the time_format option.
+ * @param string $d Optional Either 'G', 'U', or php date format defaults to the value specified in the time_format option.
  * @param int|object $post Optional post ID or object. Default is global $post object.
  * @return string
@@ -1312 +1312 @@
  * @since 2.0.0
  *
- * @param string $d Either 'G', 'U', or php date format.
- * @param bool $gmt Whether of not to return the gmt time.
+ * @param string $d Optional Either 'G', 'U', or php date format.
+ * @param bool $gmt Optional, default is false. Whether of not to return the gmt time.
  * @param int|object $post Optional post ID or object. Default is global $post object.
  * @param bool $translate Whether to translate the time string or not
@@ -1335 +1335 @@
  * @since 2.0.0
  *
- * @param string $d Either 'G', 'U', or php date format defaults to the value specified in the time_format option.
+ * @param string $d Optional Either 'G', 'U', or php date format defaults to the value specified in the time_format option.
  */
 function the_modified_time($d = '') {
@@ -1346 +1346 @@
  * @since 2.0.0
  *
- * @param string $d Either 'G', 'U', or php date format defaults to the value specified in the time_format option.
+ * @param string $d Optional Either 'G', 'U', or php date format defaults to the value specified in the time_format option.
  * @return string
  */
@@ -1362 +1362 @@
  * @since 2.0.0
  *
- * @param string $d Either 'G', 'U', or php date format.
- * @param bool $gmt Whether of not to return the gmt time.
- * @param int|object $post A post_id or post object
- * @param bool translate Whether to translate the result or not
+ * @param string $d Optional, default is 'U'. Either 'G', 'U', or php date format.
+ * @param bool $gmt Optional, default is false. Whether of not to return the gmt time.
+ * @param int|object $post Optional, default is global post object. A post_id or post object
+ * @param bool $translate Optional, default is false. Whether to translate the result or not
  * @return string Returns timestamp
  */
@@ -1402 +1402 @@
  * @since 0.71
  *
- * @param string $before output before the date.
- * @param string $after output after the date.
+ * @param string $before Optional Output before the date.
+ * @param string $after Optional Output after the date.
   */
 function the_weekday_date($before='',$after='') {
@@ -1443 +1443 @@
  * @since 2.8.0
  *
- * @param boolean $add Add or remove links. Defaults to true.
+ * @param boolean $add Optional, default is true. Add or remove links. Defaults to true.
  */
 function automatic_feed_links( $add = true ) {
@@ -1461 +1461 @@
  * @param array $args Optional arguments.
  */
-function feed_links( $args ) {
+function feed_links( $args = array() ) {
     $defaults = array(
         /* translators: Separator between blog name and feed type in feed links */
@@ -1484 +1484 @@
  * @param array $args Optional arguments.
  */
-function feed_links_extra( $args ) {
+function feed_links_extra( $args = array() ) {
     $defaults = array(
         /* translators: Separator between blog name and feed type in feed links */
@@ -1644 +1644 @@
  *
  * @param string $content Textarea content.
- * @param string $id HTML ID attribute value.
- * @param string $prev_id HTML ID name for switching back and forth between visual editors.
+ * @param string $id Optional, default is 'content'. HTML ID attribute value.
+ * @param string $prev_id Optional, default is 'title'. HTML ID name for switching back and forth between visual editors.
  * @param bool $media_buttons Optional, default is true. Whether to display media buttons.
  * @param int $tab_index Optional, default is 2. Tabindex for textarea element.
@@ -1904 +1904 @@
  * @param string $name The name of the theme.
  * @param string $url The url of the css file containing the colour scheme.
- * @param array @colors An array of CSS color definitions which are used to give the user a feel for the theme.
+ * @param array @colors Optional An array of CSS color definitions which are used to give the user a feel for the theme.
  */
 function wp_admin_css_color($key, $name, $url, $colors = array()) {