From 529c973323d9cb0306a809ec3ad193b3268ec374 Mon Sep 17 00:00:00 2001
From: Sergey Biryukov <sergeybiryukov@git.wordpress.org>
Date: Thu, 12 Sep 2013 22:58:45 +0000
Subject: [PATCH] Inline documentation fixes and additions for
 wp-admin/revision.php and wp-admin/includes/revision.php.

props adamsilverstein.
see #25283.

git-svn-id: https://develop.svn.wordpress.org/trunk@25419 602fd350-edb4-49c9-b593-d223f7449a82
---
 src/wp-admin/includes/revision.php | 16 ++++++++--------
 src/wp-admin/revision.php          | 11 ++++++++++-
 2 files changed, 18 insertions(+), 9 deletions(-)

diff --git a/src/wp-admin/includes/revision.php b/src/wp-admin/includes/revision.php
index 597ec1f02c..1cc9cb33e6 100644
--- a/src/wp-admin/includes/revision.php
+++ b/src/wp-admin/includes/revision.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * WordPress Administration Revisions API.
+ * WordPress Administration Revisions API
  *
  * @package WordPress
  * @subpackage Administration
@@ -11,12 +11,12 @@
  *
  * @since 3.6.0
  *
- * @param object $post The post object.
- * @param int $compare_from The revision id to compare from.
- * @param int $compare_to The revision id to come to.
+ * @param object|int $post         The post object. Also accepts a post ID.
+ * @param int        $compare_from The revision ID to compare from.
+ * @param int        $compare_to   The revision ID to come to.
  *
  * @return array|bool Associative array of a post's revisioned fields and their diffs.
- * 	Or, false on failure.
+ *                    Or, false on failure.
  */
 function wp_get_revision_ui_diff( $post, $compare_from, $compare_to ) {
 	if ( ! $post = get_post( $post ) )
@@ -85,9 +85,9 @@ function wp_get_revision_ui_diff( $post, $compare_from, $compare_to ) {
  *
  * @since 3.6.0
  *
- * @param object $post The post object.
- * @param int $selected_revision_id The selected revision id.
- * @param int $from (optional) The revision id to compare from.
+ * @param object|int $post          The post object. Also accepts a post ID.
+ * @param int $selected_revision_id The selected revision ID.
+ * @param int $from                 Optional. The revision ID to compare from.
  *
  * @return array An associative array of revision data and related settings.
  */
diff --git a/src/wp-admin/revision.php b/src/wp-admin/revision.php
index b6b4ae821e..43ff3be809 100644
--- a/src/wp-admin/revision.php
+++ b/src/wp-admin/revision.php
@@ -1,9 +1,18 @@
 <?php
 /**
- * Revisions administration panel.
+ * Revisions administration panel
+ * 
+ * Requires wp-admin/includes/revision.php.
  *
  * @package WordPress
  * @subpackage Administration
+ * @since 2.6.0
+ * 
+ * @param int    revision Optional. The revision ID.
+ * @param string action   The action to take.
+ *                        Accepts 'restore', 'view' or 'edit'. 
+ * @param int    from     The revision to compare from.
+ * @param int    to       Optional, required if revision missing. The revision to compare to.
  */
 
 /** WordPress Administration Bootstrap */