Changeset 15590 for trunk/wp-includes/link-template.php

Timestamp:

09/07/2010 11:21:11 AM (14 years ago)

Author:

nacin

Message:

Phpdoc argument/@param cleanups. props duck_, see #14783.

File:

• trunk/wp-includes/link-template.php (modified) (4 diffs)

trunk/wp-includes/link-template.php

@@ -28 +28 @@
  * @uses $wp_rewrite
  *
- * @param $string String a URL with or without a trailing slash.
- * @param $type_of_url String the type of URL being considered (e.g. single, category, etc) for use in the filter.
+ * @param string $string URL with or without a trailing slash.
+ * @param string $type_of_url The type of URL being considered (e.g. single, category, etc) for use in the filter.
  * @return string
  */
@@ -1155 +1155 @@
  * @param bool $in_same_cat Optional. Whether returned post should be in same category.
  * @param string $excluded_categories Optional. Excluded categories IDs.
- * @param bool $previous Optional. Whether to retrieve first post.
+ * @param bool $start Optional. Whether to retrieve first or last post.
  * @return object
  */
@@ -1201 +1201 @@
  * @param bool $in_same_cat Optional. Whether link should be in same category.
  * @param string $excluded_categories Optional. Excluded categories IDs.
- * @param bool $start Optional, default is true. Whether display link to first post.
+ * @param bool $start Optional, default is true. Whether display link to first or last post.
  * @return string
  */
@@ -2187 +2187 @@
  *
  * @param int $id A post or blog id.  Default is 0, which means the current post or blog.
- * @param string $contex Whether the id is a 'blog' id, 'post' id, or 'media' id.  If 'post', the post_type of the post is consulted.  If 'query', the current query is consulted to determine the id and context. Default is 'post'.
+ * @param string $context Whether the id is a 'blog' id, 'post' id, or 'media' id. If 'post', the post_type of the post is consulted. If 'query', the current query is consulted to determine the id and context. Default is 'post'.
  * @param bool $allow_slugs Whether to allow post slugs in the shortlink. It is up to the plugin how and whether to honor this.
  * @return string A shortlink or an empty string if no shortlink exists for the requested resource or if shortlinks are not enabled.