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.

Built from https://develop.svn.wordpress.org/trunk@30284


git-svn-id: http://core.svn.wordpress.org/trunk@30284 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes
2014-11-08 20:56:22 +00:00
parent 77e2821d54
commit 92c153aa8c
4 changed files with 6 additions and 7 deletions

View File

@@ -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 ) {