Update docs for Revision::getRevisionText()
authorSiebrand Mazeland <s.mazeland@xs4all.nl>
Thu, 19 Dec 2013 12:32:52 +0000 (13:32 +0100)
committerIAlex <codereview@emsenhuber.ch>
Wed, 1 Jan 2014 15:32:48 +0000 (15:32 +0000)
Change-Id: I9e4218bec9fd69a50e06ba9fcd8bdf8461163a47

includes/Revision.php

index 71b1858..1ad0b4a 100644 (file)
@@ -1203,15 +1203,15 @@ class Revision implements IDBAccessObject {
        /**
          * Get revision text associated with an old or archive row
          * $row is usually an object from wfFetchRow(), both the flags and the text
-         * field must be included
+         * field must be included.
          *
-         * @param $row Object: the text data
-         * @param string $prefix table prefix (default 'old_')
-         * @param string|false $wiki the name of the wiki to load the revision text from
-         *         (same as the the wiki $row was loaded from) or false to indicate the local
-         *         wiki (this is the default). Otherwise, it must be a symbolic wiki database
-         *         identifier as understood by the LoadBalancer class.
-         * @return String: text the text requested or false on failure
+         * @param stdClass $row The text data
+         * @param string $prefix Table prefix (default 'old_')
+         * @param string|bool $wiki The name of the wiki to load the revision text from
+         *   (same as the the wiki $row was loaded from) or false to indicate the local
+         *   wiki (this is the default). Otherwise, it must be a symbolic wiki database
+         *   identifier as understood by the LoadBalancer class.
+         * @return string Text the text requested or false on failure
          */
        public static function getRevisionText( $row, $prefix = 'old_', $wiki = false ) {
                wfProfileIn( __METHOD__ );