From 72cc949b5d547cf856ac36f95c91dc9d7ecebc7a Mon Sep 17 00:00:00 2001
From: "Drew Jaynes (DrewAPicture)" <drewapicture@git.wordpress.org>
Date: Sat, 8 Nov 2014 20:55:14 +0000
Subject: [PATCH] Fix the syntax for some status-related documentation
 introduced in [30155].

* Variables in DocBlocks should be backtick-escaped
* Parameter and return types should be as specific as possible
* `@param` types and variables should align with each other, but not intentionally with the `@return` description

See #30230.


git-svn-id: https://develop.svn.wordpress.org/trunk@30284 602fd350-edb4-49c9-b593-d223f7449a82
---
 src/wp-admin/includes/ajax-actions.php | 3 +--
 src/wp-includes/post.php               | 2 +-
 src/wp-includes/revision.php           | 6 +++---
 3 files changed, 5 insertions(+), 6 deletions(-)

diff --git a/src/wp-admin/includes/ajax-actions.php b/src/wp-admin/includes/ajax-actions.php
index a4835b77e5..5448f24c53 100644
--- a/src/wp-admin/includes/ajax-actions.php
+++ b/src/wp-admin/includes/ajax-actions.php
@@ -1149,8 +1149,7 @@ function wp_ajax_add_meta() {
 		if ( isset($_POST['metakeyselect']) && '#NONE#' == $_POST['metakeyselect'] && empty($_POST['metakeyinput']) )
 			wp_die( 1 );
 
-		// If the post is an autodraft, save the post as a draft and then
-		// attempt to save the meta.
+		// If the post is an autodraft, save the post as a draft and then attempt to save the meta.
 		if ( $post->post_status == 'auto-draft' ) {
 			$save_POST = $_POST; // Backup $_POST
 			$_POST = array(); // Make it empty for edit_post()
diff --git a/src/wp-includes/post.php b/src/wp-includes/post.php
index 7fa0d7e8ad..68f89d660b 100644
--- a/src/wp-includes/post.php
+++ b/src/wp-includes/post.php
@@ -1069,7 +1069,7 @@ function get_post_status_object( $post_status ) {
  * @see register_post_status()
  *
  * @param array|string $args     Optional. Array or string of post status arguments to compare against
- *                               properties of the global $wp_post_statuses objects. Default empty array.
+ *                               properties of the global `$wp_post_statuses objects`. Default empty array.
  * @param string       $output   Optional. The type of output to return, either 'names' or 'objects'. Default 'names'.
  * @param string       $operator Optional. The logical operation to perform. 'or' means only one element
  *                               from the array needs to match; 'and' means all elements must match.
diff --git a/src/wp-includes/revision.php b/src/wp-includes/revision.php
index 2661accd7f..6bdbf505b7 100644
--- a/src/wp-includes/revision.php
+++ b/src/wp-includes/revision.php
@@ -77,8 +77,8 @@ function _wp_post_revision_fields( $post = null, $autosave = false ) {
  *
  * @since 2.6.0
  *
- * @param  int   $post_id The ID of the post to save as a revision.
- * @return mixed Null or 0 if error, new revision ID, if success.
+ * @param  int $post_id The ID of the post to save as a revision.
+ * @return null|int Null or 0 if error, new revision ID, if success.
  */
 function wp_save_post_revision( $post_id ) {
 	if ( defined( 'DOING_AUTOSAVE' ) && DOING_AUTOSAVE )
@@ -455,7 +455,7 @@ function wp_revisions_enabled( $post ) {
  *
  * @since 3.6.0
  *
- * @param  object $post The post object.
+ * @param WP_Post $post The post object.
  * @return int The number of revisions to keep.
  */
 function wp_revisions_to_keep( $post ) {