Changeset 25419

Timestamp:

09/12/2013 10:58:45 PM (11 years ago)

Author:

SergeyBiryukov

Message:

Inline documentation fixes and additions for wp-admin/revision.php and wp-admin/includes/revision.php.

props adamsilverstein.
see #25283.

Location:

trunk/src/wp-admin

Files:

• includes/revision.php (modified) (3 diffs)
• revision.php (modified) (1 diff)

trunk/src/wp-admin/includes/revision.php

@@ -1 +1 @@
 <?php
 /**
- * WordPress Administration Revisions API.
+ * WordPress Administration Revisions API
  *
  * @package WordPress
@@ -12 +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 ) {
@@ -86 +86 @@
  * @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.

trunk/src/wp-admin/revision.php

@@ -1 +1 @@
 <?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.
  */