From 18a208af1bba93666bac11ed32f8a6b42fb31668 Mon Sep 17 00:00:00 2001
From: Andrew Nacin <wp@andrewnacin.com>
Date: Wed, 17 Jul 2013 20:39:35 +0000
Subject: [PATCH] Inline docs for admin/includes/revision.php. props
 DrewAPicture, fixes #24742.

git-svn-id: http://core.svn.wordpress.org/trunk@24722 1a063a9b-81f0-0310-95a4-ce76da25c4cd
---
 wp-admin/includes/revision.php | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/wp-admin/includes/revision.php b/wp-admin/includes/revision.php
index eec31092b7..ab4d09ac65 100644
--- a/wp-admin/includes/revision.php
+++ b/wp-admin/includes/revision.php
@@ -1,5 +1,21 @@
 <?php
+/**
+ * WordPress Administration Revisions API.
+ *
+ * @package WordPress
+ * @subpackage Administration
+ */
 
+/**
+ * Get the revision UI diff.
+ *
+ * @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.
+ *
+ * @return array|bool Associative array of a post's revisioned fields and their diffs.
+ * 	Or, false on failure.
+ */
 function wp_get_revision_ui_diff( $post, $compare_from, $compare_to ) {
 	if ( ! $post = get_post( $post ) )
 		return false;
@@ -61,6 +77,15 @@ function wp_get_revision_ui_diff( $post, $compare_from, $compare_to ) {
 	return $return;
 }
 
+/**
+ * Prepare revisions for JavaScript.
+ *
+ * @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.
+ *
+ * @return array An associative array of revision daIta and related settings.
+ */
 function wp_prepare_revisions_for_js( $post, $selected_revision_id, $from = null ) {
 	$post = get_post( $post );
 	$revisions = $authors = array();