Add/update/remove incomplete/incorrect documentation
authorSiebrand Mazeland <s.mazeland@xs4all.nl>
Sat, 16 Nov 2013 21:19:42 +0000 (22:19 +0100)
committerIAlex <codereview@emsenhuber.ch>
Sun, 17 Nov 2013 21:53:34 +0000 (21:53 +0000)
Change-Id: I3c2c7f61d9a579ad794ce7b564ccc8a7cfb9b6fc

includes/api/ApiBase.php
includes/api/ApiQueryImageInfo.php
includes/api/ApiQueryLinks.php

index f776e6d..c2b942a 100644 (file)
@@ -1239,7 +1239,7 @@ abstract class ApiBase extends ContextSource {
         *
         * @since 1.22
         * @param Status $status Status object
-        * @throws UsageException
+        * @throws MWException
         */
        public function dieStatus( $status ) {
                if ( $status->isGood() ) {
@@ -1519,6 +1519,7 @@ abstract class ApiBase extends ContextSource {
         * Internal code errors should be reported with this method
         * @param string $method Method or function name
         * @param string $message Error message
+        * @throws MWException
         */
        protected static function dieDebug( $method, $message ) {
                throw new MWException( "Internal error in $method: $message" );
index 9981ec1..91a9a7d 100644 (file)
@@ -310,7 +310,7 @@ class ApiQueryImageInfo extends ApiQueryBase {
         * @param array $prop of properties to get (in the keys)
         * @param $result ApiResult object
         * @param array $thumbParams containing 'width' and 'height' items, or null
-        * @param string|array $metadataOpts Options for metadata fetching.
+        * @param array|bool|string $metadataOpts Options for metadata fetching.
         *   This is an array consisting of the keys:
         *    'version': The metadata version for the metadata option
         *    'language': The language for extmetadata property
index 3157a7b..1eecbe2 100644 (file)
@@ -76,8 +76,7 @@ class ApiQueryLinks extends ApiQueryGeneratorBase {
        }
 
        /**
-        * @param $resultPageSet ApiPageSet
-        * @return
+        * @param ApiPageSet $resultPageSet
         */
        private function run( $resultPageSet = null ) {
                if ( $this->getPageSet()->getGoodTitleCount() == 0 ) {