ApiBlock.php: spacing & coding style tweaks, more braces, fixed copyright symbol

[lhc/web/wiklou.git] / includes / api / ApiHelp.php

diff --git a/includes/api/ApiHelp.php b/includes/api/ApiHelp.php
index 570c787..a089222 100644 (file)
--- a/includes/api/ApiHelp.php
+++ b/includes/api/ApiHelp.php
@@ -5,7 +5,7 @@
  *
  * API for MediaWiki 1.8+
  *
- * Copyright (C) 2006 Yuri Astrakhan <FirstnameLastname@gmail.com>
+ * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -23,28 +23,38 @@
  * http://www.gnu.org/copyleft/gpl.html
  */
 
-if (!defined('MEDIAWIKI')) {
+if ( !defined( 'MEDIAWIKI' ) ) {
        // Eclipse helper - will be ignored in production
-       require_once ('ApiBase.php');
+       require_once ( 'ApiBase.php' );
 }
 
 /**
- * @addtogroup API
+ * This is a simple class to handle action=help
+ *
+ * @ingroup API
  */
 class ApiHelp extends ApiBase {
 
-       public function __construct($main, $action) {
-               parent :: __construct($main, $action);
+       public function __construct( $main, $action ) {
+               parent :: __construct( $main, $action );
        }
 
        /**
         * Stub module for displaying help when no parameters are given
         */
        public function execute() {
-               $this->dieUsage('', 'help');
+               $this->dieUsage( '', 'help' );
+       }
+
+       public function shouldCheckMaxlag() {
+               return false;
+       }
+
+       public function isReadMode() {
+               return false;
        }
 
-       protected function getDescription() {
+       public function getDescription() {
                return array (
                        'Display this help screen.'
                );
@@ -54,4 +64,3 @@ class ApiHelp extends ApiBase {
                return __CLASS__ . ': $Id$';
        }
 }
-?>