Changeset 30753 for trunk/src/wp-admin/includes/post.php

Timestamp:

12/06/2014 09:23:52 PM (10 years ago)

Author:

DrewAPicture

Message:

Convert various uses of (optional) in core parameter descriptions to use the style prescribed in the inline documentation standards for PHP.

The style for marking parameters optional in inline PHP docs is: @param type $var Optional. Description. Accepts. Default., where Accepts can be omitted on a case-by-case basis.

Props coffee2code.
Fixes #30591.

File:

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

trunk/src/wp-admin/includes/post.php

@@ -1117 +1117 @@
 
 /**
- * {@internal Missing Short Description}}
+ * Get a sample permalink based off of the post name.
  *
  * @since 2.5.0
  *
- * @param integer $id    Post ID or post object.
- * @param string $title (optional) Title
- * @param string $name (optional) Name
- * @return array With two entries of type string
+ * @param int    $id    Post ID or post object.
+ * @param string $title Optional. Title. Default null.
+ * @param string $name  Optional. Name. Default null.
+ * @return array Arra yith two entries of type string.
  */
 function get_sample_permalink($id, $title = null, $name = null) {
@@ -1186 +1186 @@
  * @since 2.5.0
  *
- * @param integer $id Post ID or post object.
- * @param string $new_title Optional. New title.
- * @param string $new_slug Optional. New slug.
+ * @param int    $id        Post ID or post object.
+ * @param string $new_title Optional. New title. Default null.
+ * @param string $new_slug  Optional. New slug. Default null.
  * @return string The HTML of the sample permalink slug editor.
  */