Return documentation

diff --git a/includes/api/ApiBase.php b/includes/api/ApiBase.php
index ad15723..614c0cc 100644 (file)
--- a/includes/api/ApiBase.php
+++ b/includes/api/ApiBase.php
@@ -655,6 +655,8 @@ abstract class ApiBase {
 
        /**
         * @deprecated since 1.17 use MWNamespace::getValidNamespaces()
+        *
+        * @return array
         */
        public static function getValidNamespaces() {
                return MWNamespace::getValidNamespaces();
@@ -1164,7 +1166,7 @@ abstract class ApiBase {
                'emptynewsection' => array( 'code' => 'emptynewsection', 'info' => 'Creating empty new sections is not possible.' ),
                'revwrongpage' => array( 'code' => 'revwrongpage', 'info' => "r\$1 is not a revision of ``\$2''" ),
                'undo-failure' => array( 'code' => 'undofailure', 'info' => 'Undo failed due to conflicting intermediate edits' ),
-               
+
                // Messages from WikiPage::doEit()
                'edit-hook-aborted' => array( 'code' => 'edit-hook-aborted', 'info' => "Your edit was aborted by an ArticleSave hook" ),
                'edit-gone-missing' => array( 'code' => 'edit-gone-missing', 'info' => "The page you tried to edit doesn't seem to exist anymore" ),

diff --git a/includes/api/ApiFeedContributions.php b/includes/api/ApiFeedContributions.php
index 1a8e7ad..66559c2 100644 (file)
--- a/includes/api/ApiFeedContributions.php
+++ b/includes/api/ApiFeedContributions.php
@@ -36,6 +36,8 @@ class ApiFeedContributions extends ApiBase {
 
        /**
         * This module uses a custom feed wrapper printer.
+        *
+        * @return ApiFormatFeedWrapper
         */
        public function getCustomPrinter() {
                return new ApiFormatFeedWrapper( $this->getMain() );

diff --git a/includes/api/ApiFeedWatchlist.php b/includes/api/ApiFeedWatchlist.php
index 3d0d3d8..44ddd10 100644 (file)
--- a/includes/api/ApiFeedWatchlist.php
+++ b/includes/api/ApiFeedWatchlist.php
@@ -44,6 +44,8 @@ class ApiFeedWatchlist extends ApiBase {
 
        /**
         * This module uses a custom feed wrapper printer.
+        *
+        * @return ApiFormatFeedWrapper
         */
        public function getCustomPrinter() {
                return new ApiFormatFeedWrapper( $this->getMain() );

diff --git a/includes/api/ApiFormatBase.php b/includes/api/ApiFormatBase.php
index 555a0fa..036d113 100644 (file)
--- a/includes/api/ApiFormatBase.php
+++ b/includes/api/ApiFormatBase.php
@@ -342,6 +342,8 @@ class ApiFormatFeedWrapper extends ApiFormatBase {
 
        /**
         * Optimization - no need to sanitize data that will not be needed
+        *
+        * @return bool
         */
        public function getNeedsRawData() {
                return true;

diff --git a/includes/api/ApiQueryUserContributions.php b/includes/api/ApiQueryUserContributions.php
index 354dc29..ba97864 100644 (file)
--- a/includes/api/ApiQueryUserContributions.php
+++ b/includes/api/ApiQueryUserContributions.php
@@ -275,6 +275,8 @@ class ApiQueryContributions extends ApiQueryBase {
 
        /**
         * Extract fields from the database row and append them to a result array
+        *
+        * @return array
         */
        private function extractRowInfo( $row ) {
                $vals = array();

diff --git a/includes/api/ApiUpload.php b/includes/api/ApiUpload.php
index 30331bc..d69bc85 100644 (file)
--- a/includes/api/ApiUpload.php
+++ b/includes/api/ApiUpload.php
@@ -428,6 +428,8 @@ class ApiUpload extends ApiBase {
        /**
         * Perform the actual upload. Returns a suitable result array on success;
         * dies on failure.
+        *
+        * @return array
         */
        protected function performUpload() {
                global $wgUser;