Changeset 24177 for trunk/wp-includes/revision.php

Timestamp:

05/05/2013 02:46:59 AM (12 years ago)

Author:

azaozz

Message:

Clean up revision.php docblocks, props DrewAPicture, fixes #24265

File:

• trunk/wp-includes/revision.php (modified) (19 diffs)

trunk/wp-includes/revision.php

@@ -14 +14 @@
  * an array whose keys are the post fields to be saved for post revisions.
  *
- * @package WordPress
- * @subpackage Post_Revisions
- * @since 2.6.0
- * @access private
+ * @since 2.6.0
+ * @access private
+ *
  * @uses apply_filters() Calls '_wp_post_revision_fields' on 'title', 'content' and 'excerpt' fields.
  *
@@ -65 +64 @@
  * @since 3.6
  * @access private
+ *
  * @return array An array of meta keys that should be revisioned.
  */
@@ -86 +86 @@
  * Adds a copy of the current post as a revision, so latest revision always matches current post
  *
- * @package WordPress
- * @subpackage Post_Revisions
  * @since 2.6.0
  *
@@ -185 +183 @@
  * otherwise returns the latest autosave.
  *
- * @package WordPress
- * @subpackage Post_Revisions
- * @since 2.6.0
+ * @since 2.6.0
+ *
  * @uses wp_get_post_revisions()
  *
@@ -213 +210 @@
  * Determines if the specified post is a revision.
  *
- * @package WordPress
- * @subpackage Post_Revisions
  * @since 2.6.0
  *
@@ -230 +225 @@
  * Determines if the specified post is an autosave.
  *
- * @package WordPress
- * @subpackage Post_Revisions
  * @since 2.6.0
  *
@@ -250 +243 @@
  * Inserts post data into the posts table as a post revision.
  *
- * @package WordPress
- * @subpackage Post_Revisions
- * @since 2.6.0
+ * @since 2.6.0
+ * @access private
  *
  * @uses wp_insert_post()
@@ -304 +296 @@
  * Gets a post revision.
  *
- * @package WordPress
- * @subpackage Post_Revisions
  * @since 2.6.0
  *
  * @uses get_post()
  *
- * @param int|object $post Post ID or post object
+ * @param int|object $post The post ID or object.
  * @param string $output Optional. OBJECT, ARRAY_A, or ARRAY_N.
- * @param string $filter Optional sanitation filter. @see sanitize_post()
- * @return mixed Null if error or post object if success
+ * @param string $filter Optional sanitation filter. @see sanitize_post().
+ * @return mixed Null if error or post object if success.
  */
 function wp_get_post_revision(&$post, $output = OBJECT, $filter = 'raw') {
@@ -340 +330 @@
  * Can restore a past revision using all fields of the post revision, or only selected fields.
  *
- * @package WordPress
- * @subpackage Post_Revisions
  * @since 2.6.0
  *
@@ -406 +394 @@
  * Deletes the row from the posts table corresponding to the specified revision.
  *
- * @package WordPress
- * @subpackage Post_Revisions
  * @since 2.6.0
  *
@@ -433 +419 @@
  * Returns all revisions of specified post.
  *
- * @package WordPress
- * @subpackage Post_Revisions
  * @since 2.6.0
  *
@@ -440 +424 @@
  *
  * @param int|object $post_id Post ID or post object
- * @return array empty if no revisions
+ * @return array An array of revisions, or an empty array if none.
  */
 function wp_get_post_revisions( $post_id = 0, $args = null ) {
@@ -464 +448 @@
  * @uses wp_revisions_to_keep()
  *
- * @param object $post
- * @return bool
+ * @param object $post The post object.
+ * @return bool True if number of revisions to keep isn't zero, false otherwise.
  */
 function wp_revisions_enabled( $post ) {
@@ -480 +464 @@
  * @uses apply_filters() Calls 'wp_revisions_to_keep' hook on the number of revisions.
  *
- * @param object $post
- * @return int
+ * @param object $post The post object.
+ * @return int The number of revisions to keep.
  */
 function wp_revisions_to_keep( $post ) {
@@ -497 +481 @@
 }
 
+/**
+ * Sets up the post object for preview based on the post autosave.
+ *
+ * @since 2.7.0
+ * @access private
+ */
 function _set_preview($post) {
 
@@ -519 +509 @@
 }
 
+/**
+ * Filters the latest content for preview from the post autosave.
+ *
+ * @since 2.7.0
+ * @access private
+ */
 function _show_post_preview() {
 
@@ -574 +570 @@
 }
 
+/**
+ * Gets the post revision version.
+ *
+ * @since 3.6.0
+ * @access private
+*/
 function _wp_get_post_revision_version( $revision ) {
     if ( is_object( $revision ) )
@@ -589 +591 @@
  * Upgrade the revisions author, add the current post as a revision and set the revisions version to 1
  *
- * @package WordPress
- * @subpackage Post_Revisions
  * @since 3.6.0
+ * @access private
  *
  * @uses wp_get_post_revisions()
@@ -684 +685 @@
  *
  * @since 3.6.0
+ *
  * @see wp_parse_args() Used to change defaults to user defined settings.
  * @uses Text_Diff