API: Documentation cleanup
authorYuri Astrakhan <yurik@users.mediawiki.org>
Fri, 6 Jul 2007 02:19:56 +0000 (02:19 +0000)
committerYuri Astrakhan <yurik@users.mediawiki.org>
Fri, 6 Jul 2007 02:19:56 +0000 (02:19 +0000)
includes/api/ApiFormatBase.php
includes/api/ApiLogin.php
includes/api/ApiMain.php

index 9fa17e4..996cbfe 100644 (file)
@@ -110,8 +110,8 @@ abstract class ApiFormatBase extends ApiBase {
 <small>
 You are looking at the HTML representation of the <?=$this->mFormat?> format.<br/>
 HTML is good for debugging, but probably is not suitable for your application.<br/>
-Please see "format" parameter documentation at the <a href='api.php'>API help</a>
-for more information.
+See <a href='http://www.mediawiki.org/wiki/API'>complete documentation</a>, or 
+<a href='api.php'>API help</a> for more information.
 </small>
 <?php
 
index 71f9c3a..2c0b7b0 100644 (file)
@@ -227,12 +227,11 @@ class ApiLogin extends ApiBase {
 
        protected function getDescription() {
                return array (
-                       'This module is used to login and get the authentication tokens. ' .
-                       'In the event of a successful log-in, a cookie will be attached ' .
-                       'to your session. In the event of a failed log-in, you will not ' .
-                       'be able to attempt another log-in through this method for 60 ' .
-                       'seconds--this is to prevent its use in aiding automated password ' .
-                       'crackers.'
+                       'This module is used to login and get the authentication tokens. ',
+                       'In the event of a successful log-in, a cookie will be attached',
+                       'to your session. In the event of a failed log-in, you will not ',
+                       'be able to attempt another log-in through this method for 60 seconds.',
+                       'This is to prevent password guessing by automated password crackers.'
                );
        }
        
index 72d09bf..7d0df36 100644 (file)
@@ -322,14 +322,24 @@ class ApiMain extends ApiBase {
        protected function getDescription() {
                return array (
                        '',
-                       'This API allows programs to access various functions of MediaWiki software.',
-                       'For more details see API Home Page @ http://www.mediawiki.org/wiki/API',
+                       '******************************************************************',
+                       '**                                                              **',
+                       '**  This is an auto-generated MediaWiki API documentation page  **',
+                       '**                                                              **',
+                       '**                  Documentation and Examples:                 **',
+                       '**               http://www.mediawiki.org/wiki/API              **',
+                       '**                                                              **',
+                       '******************************************************************',
                        '',
                        'Status: ALPHA -- all features shown on this page should be working,',
                        '                 but the API is still in active development, and  may change at any time.',
                        '                 Make sure you monitor changes to this page, wikitech-l mailing list,',
                        '                 or the source code in the includes/api directory for any changes.',
-                       ''
+                       '',
+                       'Bugs & Requests: http://bugzilla.wikimedia.org/buglist.cgi?component=API&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&order=bugs.delta_ts',
+                       '',
+                       '',
+                       '',
                );
        }