| Index: trunk/phase3/includes/api/ApiMain.php |
| — | — | @@ -180,6 +180,7 @@ |
| 181 | 181 | |
| 182 | 182 | /** |
| 183 | 183 | * Return true if the API was started by other PHP code using FauxRequest |
| | 184 | + * @return bool |
| 184 | 185 | */ |
| 185 | 186 | public function isInternalMode() { |
| 186 | 187 | return $this->mInternalMode; |
| — | — | @@ -204,6 +205,8 @@ |
| 205 | 206 | |
| 206 | 207 | /** |
| 207 | 208 | * Get the API module object. Only works after executeAction() |
| | 209 | + * |
| | 210 | + * @return ApiBase |
| 208 | 211 | */ |
| 209 | 212 | public function getModule() { |
| 210 | 213 | return $this->mModule; |
| — | — | @@ -309,6 +312,8 @@ |
| 310 | 313 | |
| 311 | 314 | /** |
| 312 | 315 | * Create an instance of an output formatter by its name |
| | 316 | + * |
| | 317 | + * @return ApiFormatBase |
| 313 | 318 | */ |
| 314 | 319 | public function createPrinterByName( $format ) { |
| 315 | 320 | if ( !isset( $this->mFormats[$format] ) ) { |
| — | — | @@ -455,6 +460,7 @@ |
| 456 | 461 | * Replace the result data with the information about an exception. |
| 457 | 462 | * Returns the error code |
| 458 | 463 | * @param $e Exception |
| | 464 | + * @return string |
| 459 | 465 | */ |
| 460 | 466 | protected function substituteResultWithError( $e ) { |
| 461 | 467 | // Printer may not be initialized if the extractRequestParams() fails for the main module |
| — | — | @@ -516,6 +522,7 @@ |
| 517 | 523 | |
| 518 | 524 | /** |
| 519 | 525 | * Set up for the execution. |
| | 526 | + * @return array |
| 520 | 527 | */ |
| 521 | 528 | protected function setupExecuteAction() { |
| 522 | 529 | // First add the id to the top element |
| — | — | @@ -692,6 +699,9 @@ |
| 693 | 700 | $printer->profileOut(); |
| 694 | 701 | } |
| 695 | 702 | |
| | 703 | + /** |
| | 704 | + * @return bool |
| | 705 | + */ |
| 696 | 706 | public function isReadMode() { |
| 697 | 707 | return false; |
| 698 | 708 | } |
| — | — | @@ -977,6 +987,7 @@ |
| 978 | 988 | |
| 979 | 989 | /** |
| 980 | 990 | * Get the array mapping module names to class names |
| | 991 | + * @return array |
| 981 | 992 | */ |
| 982 | 993 | function getModules() { |
| 983 | 994 | return $this->mModules; |