From f9619da3f02b4759ae92250c483d4bf14dfd9ee8 Mon Sep 17 00:00:00 2001 From: Nick Jenkins Date: Fri, 20 Apr 2007 08:55:14 +0000 Subject: [PATCH] Yet more doc tweaks: * Add @addtogroup tags to various classes, to try and group conceptually-related classes together. * Add brief descriptions to various Special pages, thanks to Phil Boswell. * Moving some docs to be right above the classes they represent, so that they are picked up. --- includes/AjaxDispatcher.php | 1 + includes/AjaxFunctions.php | 5 +++ includes/AjaxResponse.php | 1 + includes/CacheDependency.php | 19 ++++++++ includes/CoreParserFunctions.php | 2 +- includes/Database.php | 16 ++++++- includes/DatabaseOracle.php | 9 +++- includes/DatabasePostgres.php | 5 ++- includes/Exception.php | 7 +++ includes/Export.php | 14 ++++++ includes/FileStore.php | 3 ++ includes/ImageQueryPage.php | 3 +- includes/PageHistory.php | 4 +- includes/PageQueryPage.php | 3 +- includes/Pager.php | 8 +++- includes/Parser.php | 3 ++ includes/ParserCache.php | 3 -- includes/ParserOptions.php | 1 + includes/ParserOutput.php | 1 + includes/Profiler.php | 1 + includes/ProfilerSimple.php | 1 + includes/ProfilerSimpleUDP.php | 1 + includes/QueryPage.php | 4 +- includes/Sanitizer.php | 4 ++ includes/SearchEngine.php | 12 ++++-- includes/SearchMySQL.php | 4 +- includes/SearchMySQL4.php | 4 -- includes/SearchOracle.php | 4 +- includes/SearchPostgres.php | 8 +++- includes/SearchUpdate.php | 6 +-- includes/SpecialAllpages.php | 4 ++ includes/SpecialAncientpages.php | 2 +- includes/SpecialCategories.php | 4 ++ includes/SpecialConfirmemail.php | 15 +++---- includes/SpecialFewestrevisions.php | 6 +-- includes/SpecialImagelist.php | 4 ++ includes/SpecialImport.php | 5 ++- includes/SpecialIpblocklist.php | 3 +- includes/SpecialMostcategories.php | 1 + includes/SpecialMostimages.php | 1 + includes/SpecialMostlinked.php | 7 +-- includes/SpecialMostlinkedcategories.php | 4 -- includes/SpecialNewpages.php | 2 +- includes/SpecialPage.php | 17 +++++++- includes/SpecialPopularpages.php | 2 +- includes/SpecialPrefixindex.php | 4 ++ includes/SpecialProtectedpages.php | 1 + includes/SpecialRandompage.php | 5 +++ includes/SpecialResetpass.php | 3 ++ includes/SpecialRevisiondelete.php | 9 +++- includes/SpecialSearch.php | 2 +- includes/SpecialUncategorizedcategories.php | 2 +- includes/SpecialUnusedimages.php | 1 + includes/SpecialUnusedtemplates.php | 1 + includes/SpecialUnwatchedpages.php | 8 +--- includes/SpecialUpload.php | 2 +- includes/SpecialUploadMogile.php | 3 ++ includes/SpecialUserlogin.php | 3 +- includes/SpecialWantedcategories.php | 6 +-- includes/SpecialWantedpages.php | 2 +- includes/SpecialWhatlinkshere.php | 4 ++ includes/SpecialWithoutinterwiki.php | 3 +- includes/User.php | 1 + includes/WikiError.php | 3 ++ includes/api/ApiBase.php | 4 +- includes/api/ApiFeedWatchlist.php | 4 +- includes/api/ApiFormatBase.php | 5 ++- includes/api/ApiFormatJson.php | 6 ++- includes/api/ApiFormatJson_json.php | 48 ++++++++++++--------- includes/api/ApiFormatPhp.php | 6 ++- includes/api/ApiFormatWddx.php | 6 ++- includes/api/ApiFormatXml.php | 6 ++- includes/api/ApiFormatYaml.php | 6 ++- includes/api/ApiFormatYaml_spyc.php | 5 +-- includes/api/ApiHelp.php | 6 ++- includes/api/ApiLogin.php | 4 +- includes/api/ApiMain.php | 3 +- includes/api/ApiOpenSearch.php | 6 ++- includes/api/ApiPageSet.php | 4 +- includes/api/ApiQuery.php | 4 +- includes/api/ApiQueryAllpages.php | 4 +- includes/api/ApiQueryBacklinks.php | 6 ++- includes/api/ApiQueryBase.php | 7 ++- includes/api/ApiQueryInfo.php | 4 +- includes/api/ApiQueryLogEvents.php | 4 +- includes/api/ApiQueryRecentChanges.php | 6 ++- includes/api/ApiQueryRevisions.php | 4 +- includes/api/ApiQuerySiteinfo.php | 6 ++- includes/api/ApiQueryUserContributions.php | 4 +- includes/api/ApiQueryWatchlist.php | 4 +- includes/api/ApiResult.php | 6 ++- includes/memcached-client.php | 2 +- includes/templates/Userlogin.php | 3 ++ 93 files changed, 343 insertions(+), 137 deletions(-) diff --git a/includes/AjaxDispatcher.php b/includes/AjaxDispatcher.php index bb4709bb40..570931c87b 100644 --- a/includes/AjaxDispatcher.php +++ b/includes/AjaxDispatcher.php @@ -11,6 +11,7 @@ require_once( 'AjaxFunctions.php' ); /** * @todo Document - e.g. Provide top-level description of this class. + * @addtogroup Ajax */ class AjaxDispatcher { var $mode; diff --git a/includes/AjaxFunctions.php b/includes/AjaxFunctions.php index 5f906a33eb..98b674fe98 100644 --- a/includes/AjaxFunctions.php +++ b/includes/AjaxFunctions.php @@ -1,5 +1,10 @@ } } +/** + * @addtogroup Database + */ class DBQueryError extends DBError { public $error, $errno, $sql, $fname; @@ -277,12 +286,16 @@ class DBQueryError extends DBError { } } +/** + * @addtogroup Database + */ class DBUnexpectedError extends DBError {} /******************************************************************************/ /** * Database abstraction object + * @addtogroup Database */ class Database { @@ -2181,6 +2194,7 @@ class Database { * Database abstraction object for mySQL * Inherit all methods and properties of Database::Database() * + * @addtogroup Database * @see Database */ class DatabaseMysql extends Database { @@ -2190,7 +2204,7 @@ class DatabaseMysql extends Database { /** * Result wrapper for grabbing data queried by someone else - * + * @addtogroup Database */ class ResultWrapper { var $db, $result; diff --git a/includes/DatabaseOracle.php b/includes/DatabaseOracle.php index 9c6bb71866..2b720df7ee 100644 --- a/includes/DatabaseOracle.php +++ b/includes/DatabaseOracle.php @@ -2,6 +2,7 @@ /** * This is the Oracle database abstraction layer. + * @addtogroup Database */ class ORABlob { var $mData; @@ -19,6 +20,7 @@ class ORABlob { * The oci8 extension is fairly weak and doesn't support oci_num_rows, among * other things. We use a wrapper class to handle that and other * Oracle-specific bits, like converting column names back to lowercase. + * @addtogroup Database */ class ORAResult { private $rows; @@ -82,8 +84,11 @@ class ORAResult { } return $ret; } -}; +} +/** + * @addtogroup Database + */ class DatabaseOracle extends Database { var $mInsertId = NULL; var $mLastResult = NULL; @@ -384,7 +389,7 @@ class DatabaseOracle extends Database { } /** - * ORacle does not have a "USE INDEX" clause, so return an empty string + * Oracle does not have a "USE INDEX" clause, so return an empty string */ function useIndexClause($index) { return ''; diff --git a/includes/DatabasePostgres.php b/includes/DatabasePostgres.php index f2b982d629..7158e2d161 100644 --- a/includes/DatabasePostgres.php +++ b/includes/DatabasePostgres.php @@ -7,8 +7,8 @@ * than MySQL ones, some of them should be moved to parent * Database class. * + * @addtogroup Database */ - class PostgresField { private $name, $tablename, $type, $nullable, $max_length; @@ -63,6 +63,9 @@ END; } } +/** + * @addtogroup Database + */ class DatabasePostgres extends Database { var $mInsertId = NULL; var $mLastResult = NULL; diff --git a/includes/Exception.php b/includes/Exception.php index ad7ec14a93..81cf12f6d9 100644 --- a/includes/Exception.php +++ b/includes/Exception.php @@ -1,5 +1,8 @@ diff --git a/includes/ImageQueryPage.php b/includes/ImageQueryPage.php index 65a50a4d9b..c49b487ed1 100644 --- a/includes/ImageQueryPage.php +++ b/includes/ImageQueryPage.php @@ -5,6 +5,7 @@ * suited for reports generating images * * @package MediaWiki + * @addtogroup SpecialPage * @author Rob Church */ class ImageQueryPage extends QueryPage { @@ -63,4 +64,4 @@ class ImageQueryPage extends QueryPage { } -?> \ No newline at end of file +?> diff --git a/includes/PageHistory.php b/includes/PageHistory.php index 938eed0a2c..b1cf41f0de 100644 --- a/includes/PageHistory.php +++ b/includes/PageHistory.php @@ -14,7 +14,6 @@ * history. * */ - class PageHistory { const DIR_PREV = 0; const DIR_NEXT = 1; @@ -523,6 +522,9 @@ class PageHistory { } +/** + * @addtogroup Pager + */ class PageHistoryPager extends ReverseChronologicalPager { public $mLastRow = false, $mPageHistory; diff --git a/includes/PageQueryPage.php b/includes/PageQueryPage.php index 17ed57f136..5b82ebf6b2 100644 --- a/includes/PageQueryPage.php +++ b/includes/PageQueryPage.php @@ -4,6 +4,7 @@ * Variant of QueryPage which formats the result as a simple link to the page * * @package MediaWiki + * @addtogroup SpecialPage */ class PageQueryPage extends QueryPage { @@ -22,4 +23,4 @@ class PageQueryPage extends QueryPage { } } -?> \ No newline at end of file +?> diff --git a/includes/Pager.php b/includes/Pager.php index c135e2126b..9c2b083cdb 100644 --- a/includes/Pager.php +++ b/includes/Pager.php @@ -2,6 +2,7 @@ /** * Basic pager interface. + * @addtogroup Pager */ interface Pager { function getNavigationBar(); @@ -46,6 +47,8 @@ interface Pager { * please see the examples in PageHistory.php and SpecialIpblocklist.php. You just need * to override formatRow(), getQueryInfo() and getIndexField(). Don't forget to call the * parent constructor if you override it. + * + * @addtogroup Pager */ abstract class IndexPager implements Pager { public $mRequest; @@ -389,7 +392,8 @@ abstract class IndexPager implements Pager { /** * IndexPager with an alphabetic list and a formatted navigation bar -*/ + * @addtogroup Pager + */ abstract class AlphabeticPager extends IndexPager { public $mDefaultDirection = false; @@ -423,6 +427,7 @@ abstract class AlphabeticPager extends IndexPager { /** * IndexPager with a formatted navigation bar + * @addtogroup Pager */ abstract class ReverseChronologicalPager extends IndexPager { public $mDefaultDirection = true; @@ -455,6 +460,7 @@ abstract class ReverseChronologicalPager extends IndexPager { /** * Table-based display with a user-selectable sort order + * @addtogroup Pager */ abstract class TablePager extends IndexPager { var $mSort; diff --git a/includes/Parser.php b/includes/Parser.php index efaf303e52..89ab0915b2 100644 --- a/includes/Parser.php +++ b/includes/Parser.php @@ -86,6 +86,7 @@ define( 'MW_COLON_STATE_COMMENTDASHDASH', 7 ); * * only within ParserOptions * * + * @addtogroup Parser */ class Parser { @@ -4721,6 +4722,7 @@ class Parser /** * @todo document, briefly. + * @addtogroup Parser */ class OnlyIncludeReplacer { var $output = ''; @@ -4736,6 +4738,7 @@ class OnlyIncludeReplacer { /** * @todo document, briefly. + * @addtogroup Parser */ class StripState { var $general, $nowiki; diff --git a/includes/ParserCache.php b/includes/ParserCache.php index 752aa545f1..ad95979c39 100644 --- a/includes/ParserCache.php +++ b/includes/ParserCache.php @@ -2,9 +2,6 @@ /** * * @addtogroup Cache - */ - -/** * @todo document */ class ParserCache { diff --git a/includes/ParserOptions.php b/includes/ParserOptions.php index f165343f0d..e335720f3b 100644 --- a/includes/ParserOptions.php +++ b/includes/ParserOptions.php @@ -3,6 +3,7 @@ /** * Set options of the Parser * @todo document + * @addtogroup Parser */ class ParserOptions { diff --git a/includes/ParserOutput.php b/includes/ParserOutput.php index fa2c1b61e3..03f1819c80 100644 --- a/includes/ParserOutput.php +++ b/includes/ParserOutput.php @@ -1,6 +1,7 @@ \ No newline at end of file +?> diff --git a/includes/Sanitizer.php b/includes/Sanitizer.php index 96f89dce32..ebb0dcccae 100644 --- a/includes/Sanitizer.php +++ b/includes/Sanitizer.php @@ -315,6 +315,10 @@ $wgHtmlEntities = array( 'zwj' => 8205, 'zwnj' => 8204 ); +/** + * XHTML sanitizer for MediaWiki + * @addtogroup Parser + */ class Sanitizer { /** * Cleans up HTML, removes dangerous tags and attributes, and diff --git a/includes/SearchEngine.php b/includes/SearchEngine.php index dc10279f4d..2ef5914302 100644 --- a/includes/SearchEngine.php +++ b/includes/SearchEngine.php @@ -3,9 +3,6 @@ * Contain a class for special pages * @addtogroup Search */ - -/** - */ class SearchEngine { var $limit = 10; var $offset = 0; @@ -236,6 +233,10 @@ class SearchEngine { } } + +/** + * @addtogroup Search + */ class SearchResultSet { /** * Fetch an array of regular expression fragments for matching @@ -310,6 +311,10 @@ class SearchResultSet { } } + +/** + * @addtogroup Search + */ class SearchResult { function SearchResult( $row ) { $this->mTitle = Title::makeTitle( $row->page_namespace, $row->page_title ); @@ -332,6 +337,7 @@ class SearchResult { } /** + * @addtogroup Search */ class SearchEngineDummy { function search( $term ) { diff --git a/includes/SearchMySQL.php b/includes/SearchMySQL.php index 87878b6bc7..0e02a6845d 100644 --- a/includes/SearchMySQL.php +++ b/includes/SearchMySQL.php @@ -22,7 +22,6 @@ * Specific bits for MySQL 3 and 4 variants are in child classes. * @addtogroup Search */ - class SearchMySQL extends SearchEngine { /** * Perform a full text search query and return a result set. @@ -176,6 +175,9 @@ class SearchMySQL extends SearchEngine { } } +/** + * @addtogroup Search + */ class MySQLSearchResultSet extends SearchResultSet { function MySQLSearchResultSet( $resultSet, $terms ) { $this->mResultSet = $resultSet; diff --git a/includes/SearchMySQL4.php b/includes/SearchMySQL4.php index dbd88ecac5..97ce385014 100644 --- a/includes/SearchMySQL4.php +++ b/includes/SearchMySQL4.php @@ -21,10 +21,6 @@ * Search engine hook for MySQL 4+ * @addtogroup Search */ - -/** - * @addtogroup Search - */ class SearchMySQL4 extends SearchMySQL { var $strictMatching = true; diff --git a/includes/SearchOracle.php b/includes/SearchOracle.php index 8f1372946e..c9a675e6c7 100644 --- a/includes/SearchOracle.php +++ b/includes/SearchOracle.php @@ -21,7 +21,6 @@ * Search engine hook base class for Oracle (ConText). * @addtogroup Search */ - class SearchOracle extends SearchEngine { function __construct($db) { $this->db = $db; @@ -208,6 +207,9 @@ class SearchOracle extends SearchEngine { } } +/** + * @addtogroup Search + */ class OracleSearchResultSet extends SearchResultSet { function __construct($resultSet, $terms) { $this->mResultSet = $resultSet; diff --git a/includes/SearchPostgres.php b/includes/SearchPostgres.php index 390fcd1fbb..421d9660f1 100644 --- a/includes/SearchPostgres.php +++ b/includes/SearchPostgres.php @@ -21,7 +21,6 @@ * Search engine hook base class for Postgres * @addtogroup Search */ - class SearchPostgres extends SearchEngine { function SearchPostgres( $db ) { @@ -182,7 +181,9 @@ class SearchPostgres extends SearchEngine { } ## end of the SearchPostgres class - +/** + * @addtogroup Search + */ class PostgresSearchResult extends SearchResult { function PostgresSearchResult( $row ) { $this->mTitle = Title::makeTitle( $row->page_namespace, $row->page_title ); @@ -193,6 +194,9 @@ class PostgresSearchResult extends SearchResult { } } +/** + * @addtogroup Search + */ class PostgresSearchResultSet extends SearchResultSet { function PostgresSearchResultSet( $resultSet, $terms ) { $this->mResultSet = $resultSet; diff --git a/includes/SearchUpdate.php b/includes/SearchUpdate.php index e79c1d083e..724197c157 100644 --- a/includes/SearchUpdate.php +++ b/includes/SearchUpdate.php @@ -1,10 +1,7 @@ - */ - /** * Main execution point * @@ -18,6 +10,13 @@ function wfSpecialConfirmemail( $par ) { $form->execute( $par ); } +/** + * Special page allows users to request email confirmation message, and handles + * processing of the confirmation code when the link in the email is followed + * + * @addtogroup SpecialPage + * @author Rob Church + */ class EmailConfirmation extends SpecialPage { /** diff --git a/includes/SpecialFewestrevisions.php b/includes/SpecialFewestrevisions.php index 160f371c51..849438f111 100644 --- a/includes/SpecialFewestrevisions.php +++ b/includes/SpecialFewestrevisions.php @@ -1,14 +1,12 @@ doQuery( $offset, $limit ); } -?> \ No newline at end of file +?> diff --git a/includes/SpecialImagelist.php b/includes/SpecialImagelist.php index 390fb54d04..92b9ae1161 100644 --- a/includes/SpecialImagelist.php +++ b/includes/SpecialImagelist.php @@ -23,6 +23,10 @@ function wfSpecialImagelist() { . $nav ); } +/** + * @addtogroup SpecialPage + * @addtogroup Pager + */ class ImageListPager extends TablePager { var $mFieldNames = null; var $mMessages = array(); diff --git a/includes/SpecialImport.php b/includes/SpecialImport.php index b6d4b0d8c8..22c353726a 100644 --- a/includes/SpecialImport.php +++ b/includes/SpecialImport.php @@ -160,6 +160,7 @@ function wfSpecialImport( $page = '' ) { /** * Reporting callback + * @addtogroup SpecialPage */ class ImportReporter { function __construct( $importer, $upload, $interwiki ) { @@ -383,7 +384,7 @@ class WikiRevision { } /** - * + * implements Special:Import * @addtogroup SpecialPage */ class WikiImporter { @@ -792,6 +793,7 @@ class WikiImporter { /** * @todo document (e.g. one-sentence class description). + * @addtogroup SpecialPage */ class ImportStringSource { function ImportStringSource( $string ) { @@ -815,6 +817,7 @@ class ImportStringSource { /** * @todo document (e.g. one-sentence class description). + * @addtogroup SpecialPage */ class ImportStreamSource { function ImportStreamSource( $handle ) { diff --git a/includes/SpecialIpblocklist.php b/includes/SpecialIpblocklist.php index e5c285c0c2..8cb5729e79 100644 --- a/includes/SpecialIpblocklist.php +++ b/includes/SpecialIpblocklist.php @@ -45,7 +45,7 @@ function wfSpecialIpblocklist() { } /** - * @todo document + * implements Special:ipblocklist GUI * @addtogroup SpecialPage */ class IPUnblockForm { @@ -321,6 +321,7 @@ class IPUnblockForm { /** * @todo document + * @addtogroup Pager */ class IPBlocklistPager extends ReverseChronologicalPager { public $mForm, $mConds; diff --git a/includes/SpecialMostcategories.php b/includes/SpecialMostcategories.php index e761942669..df2b9adf24 100644 --- a/includes/SpecialMostcategories.php +++ b/includes/SpecialMostcategories.php @@ -8,6 +8,7 @@ */ /** + * implements Special:Mostcategories * @addtogroup SpecialPage */ class MostcategoriesPage extends QueryPage { diff --git a/includes/SpecialMostimages.php b/includes/SpecialMostimages.php index 6b01d7d5ba..9d16f389df 100644 --- a/includes/SpecialMostimages.php +++ b/includes/SpecialMostimages.php @@ -8,6 +8,7 @@ */ /** + * implements Special:Mostimages * @addtogroup SpecialPage */ class MostimagesPage extends ImageQueryPage { diff --git a/includes/SpecialMostlinked.php b/includes/SpecialMostlinked.php index 2ba9015d4d..ab089cf8d8 100644 --- a/includes/SpecialMostlinked.php +++ b/includes/SpecialMostlinked.php @@ -1,7 +1,8 @@ execute( $par ); } +/** + * @addtogroup SpecialPage + */ class PasswordResetForm extends SpecialPage { function __construct( $name=null, $reset=null ) { if( $name !== null ) { diff --git a/includes/SpecialRevisiondelete.php b/includes/SpecialRevisiondelete.php index fb5e9ec8c4..5c70d5aed0 100644 --- a/includes/SpecialRevisiondelete.php +++ b/includes/SpecialRevisiondelete.php @@ -35,6 +35,10 @@ function wfSpecialRevisiondelete( $par = null ) { } } +/** + * Implements the GUI for Revision Deletion. + * @addtogroup SpecialPage + */ class RevisionDeleteForm { /** * @param Title $page @@ -170,7 +174,10 @@ class RevisionDeleteForm { } } - +/** + * Implements the actions for Revision Deletion. + * @addtogroup SpecialPage + */ class RevisionDeleter { function __construct( $db ) { $this->db = $db; diff --git a/includes/SpecialSearch.php b/includes/SpecialSearch.php index e96c875351..fdaa8541a5 100644 --- a/includes/SpecialSearch.php +++ b/includes/SpecialSearch.php @@ -42,7 +42,7 @@ function wfSpecialSearch( $par = '' ) { } /** - * @todo document + * implements Special:Search - Run text & title search and display the output * @addtogroup SpecialPage */ class SpecialSearch { diff --git a/includes/SpecialUncategorizedcategories.php b/includes/SpecialUncategorizedcategories.php index 4d4941ffd3..e02c9bbdce 100644 --- a/includes/SpecialUncategorizedcategories.php +++ b/includes/SpecialUncategorizedcategories.php @@ -10,7 +10,7 @@ require_once( "SpecialUncategorizedpages.php" ); /** - * + * implements Special:Uncategorizedcategories * @addtogroup SpecialPage */ class UncategorizedCategoriesPage extends UncategorizedPagesPage { diff --git a/includes/SpecialUnusedimages.php b/includes/SpecialUnusedimages.php index b4fb403db8..6b99192a40 100644 --- a/includes/SpecialUnusedimages.php +++ b/includes/SpecialUnusedimages.php @@ -5,6 +5,7 @@ */ /** + * implements Special:Unusedimages * @addtogroup SpecialPage */ class UnusedimagesPage extends ImageQueryPage { diff --git a/includes/SpecialUnusedtemplates.php b/includes/SpecialUnusedtemplates.php index 033066dbcf..8b72e8a7dc 100644 --- a/includes/SpecialUnusedtemplates.php +++ b/includes/SpecialUnusedtemplates.php @@ -1,6 +1,7 @@ * @copyright © 2006 Rob Church * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License 2.0 or later diff --git a/includes/SpecialUnwatchedpages.php b/includes/SpecialUnwatchedpages.php index 6d067f3742..fed0b5906a 100644 --- a/includes/SpecialUnwatchedpages.php +++ b/includes/SpecialUnwatchedpages.php @@ -1,17 +1,13 @@ * @copyright Copyright © 2005, Ævar Arnfjörð Bjarmason * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License 2.0 or later */ - -/** - * @addtogroup SpecialPage - */ class UnwatchedpagesPage extends QueryPage { function getName() { return 'Unwatchedpages'; } diff --git a/includes/SpecialUpload.php b/includes/SpecialUpload.php index af4070a686..2d6e6baceb 100644 --- a/includes/SpecialUpload.php +++ b/includes/SpecialUpload.php @@ -15,7 +15,7 @@ function wfSpecialUpload() { } /** - * + * implements Special:Upload * @addtogroup SpecialPage */ class UploadForm { diff --git a/includes/SpecialUploadMogile.php b/includes/SpecialUploadMogile.php index fb4ae5325b..9450d22b5e 100644 --- a/includes/SpecialUploadMogile.php +++ b/includes/SpecialUploadMogile.php @@ -18,6 +18,9 @@ function wfSpecialUploadMogile() { $form->execute(); } +/** + * @addtogroup SpecialPage + */ class UploadFormMogile extends UploadForm { /** * Move the uploaded file from its temporary location to the final diff --git a/includes/SpecialUserlogin.php b/includes/SpecialUserlogin.php index a5f2521039..ff3abc5767 100644 --- a/includes/SpecialUserlogin.php +++ b/includes/SpecialUserlogin.php @@ -19,10 +19,9 @@ function wfSpecialUserlogin() { } /** - * @todo document, briefly. + * implements Special:Login * @addtogroup SpecialPage */ - class LoginForm { const SUCCESS = 0; diff --git a/includes/SpecialWantedcategories.php b/includes/SpecialWantedcategories.php index eab44d6bd2..27a9f17649 100644 --- a/includes/SpecialWantedcategories.php +++ b/includes/SpecialWantedcategories.php @@ -1,6 +1,6 @@ execute(); } +/** + * implements Special:Whatlinkshere + * @addtogroup SpecialPage + */ class WhatLinksHerePage { var $request, $par; var $limit, $from, $back, $target, $namespace; diff --git a/includes/SpecialWithoutinterwiki.php b/includes/SpecialWithoutinterwiki.php index 1567b290bd..e5341d5df4 100644 --- a/includes/SpecialWithoutinterwiki.php +++ b/includes/SpecialWithoutinterwiki.php @@ -4,6 +4,7 @@ * Special page lists pages without language links * * @package MediaWiki + * @addtogroup SpecialPage * @author Rob Church */ class WithoutInterwikiPage extends PageQueryPage { @@ -52,4 +53,4 @@ function wfSpecialWithoutinterwiki() { $wip->doQuery( $offset, $limit ); } -?> \ No newline at end of file +?> diff --git a/includes/User.php b/includes/User.php index 56d4cccd9d..d0c2db68a3 100644 --- a/includes/User.php +++ b/includes/User.php @@ -17,6 +17,7 @@ define( 'EDIT_TOKEN_SUFFIX', '\\' ); /** * Thrown by User::setPassword() on error + * @addtogroup Exception */ class PasswordError extends MWException { // NOP diff --git a/includes/WikiError.php b/includes/WikiError.php index 1b3f7f0aa9..064db61a76 100644 --- a/includes/WikiError.php +++ b/includes/WikiError.php @@ -24,6 +24,7 @@ /** * Since PHP4 doesn't have exceptions, here's some error objects * loosely modeled on the standard PEAR_Error model... + * @addtogroup Exception */ class WikiError { /** @@ -64,6 +65,7 @@ class WikiError { /** * Localized error message object + * @addtogroup Exception */ class WikiErrorMsg extends WikiError { /** @@ -79,6 +81,7 @@ class WikiErrorMsg extends WikiError { /** * @todo document + * @addtogroup Exception */ class WikiXmlError extends WikiError { /** diff --git a/includes/api/ApiBase.php b/includes/api/ApiBase.php index a29e3360cc..a8b1939958 100644 --- a/includes/api/ApiBase.php +++ b/includes/api/ApiBase.php @@ -1,6 +1,5 @@ \ No newline at end of file +?> diff --git a/includes/api/ApiFeedWatchlist.php b/includes/api/ApiFeedWatchlist.php index 335df324b7..97d1f79897 100644 --- a/includes/api/ApiFeedWatchlist.php +++ b/includes/api/ApiFeedWatchlist.php @@ -1,6 +1,5 @@ \ No newline at end of file +?> diff --git a/includes/api/ApiFormatJson_json.php b/includes/api/ApiFormatJson_json.php index c15cdd8003..2cd87930b3 100644 --- a/includes/api/ApiFormatJson_json.php +++ b/includes/api/ApiFormatJson_json.php @@ -45,7 +45,7 @@ * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH * DAMAGE. * -* @addtogroup Services_JSON +* @addtogroup API * @author Michal Migurski * @author Matt Knapp * @author Brett Stimmerman @@ -91,26 +91,28 @@ define('SERVICES_JSON_LOOSE_TYPE', 16); define('SERVICES_JSON_SUPPRESS_ERRORS', 32); /** -* Converts to and from JSON format. -* -* Brief example of use: -* -* -* // create a new instance of Services_JSON -* $json = new Services_JSON(); -* -* // convert a complexe value to JSON notation, and send it to the browser -* $value = array('foo', 'bar', array(1, 2, 'baz'), array(3, array(4))); -* $output = $json->encode($value); -* -* print($output); -* // prints: ["foo","bar",[1,2,"baz"],[3,[4]]] -* -* // accept incoming POST data, assumed to be in JSON notation -* $input = file_get_contents('php://input', 1000000); -* $value = $json->decode($input); -* -*/ + * Converts to and from JSON format. + * + * Brief example of use: + * + * + * // create a new instance of Services_JSON + * $json = new Services_JSON(); + * + * // convert a complexe value to JSON notation, and send it to the browser + * $value = array('foo', 'bar', array(1, 2, 'baz'), array(3, array(4))); + * $output = $json->encode($value); + * + * print($output); + * // prints: ["foo","bar",[1,2,"baz"],[3,[4]]] + * + * // accept incoming POST data, assumed to be in JSON notation + * $input = file_get_contents('php://input', 1000000); + * $value = $json->decode($input); + * + * + * @addtogroup API + */ class Services_JSON { /** @@ -812,6 +814,9 @@ class Services_JSON if (class_exists('PEAR_Error')) { + /** + * @addtogroup API + */ class Services_JSON_Error extends PEAR_Error { function Services_JSON_Error($message = 'unknown error', $code = null, @@ -825,6 +830,7 @@ if (class_exists('PEAR_Error')) { /** * @todo Ultimately, this class shall be descended from PEAR_Error + * @addtogroup API */ class Services_JSON_Error { diff --git a/includes/api/ApiFormatPhp.php b/includes/api/ApiFormatPhp.php index f635f4ca79..20480b6df4 100644 --- a/includes/api/ApiFormatPhp.php +++ b/includes/api/ApiFormatPhp.php @@ -1,6 +1,5 @@ \ No newline at end of file +?> diff --git a/includes/api/ApiFormatWddx.php b/includes/api/ApiFormatWddx.php index 71f13d4a3a..ad902b630c 100644 --- a/includes/api/ApiFormatWddx.php +++ b/includes/api/ApiFormatWddx.php @@ -1,6 +1,5 @@ \ No newline at end of file +?> diff --git a/includes/api/ApiFormatXml.php b/includes/api/ApiFormatXml.php index 5d4e776f4a..0c81c2fc9c 100644 --- a/includes/api/ApiFormatXml.php +++ b/includes/api/ApiFormatXml.php @@ -1,6 +1,5 @@ \ No newline at end of file +?> diff --git a/includes/api/ApiFormatYaml.php b/includes/api/ApiFormatYaml.php index 006e9733a0..5fc89b9a40 100644 --- a/includes/api/ApiFormatYaml.php +++ b/includes/api/ApiFormatYaml.php @@ -1,6 +1,5 @@ \ No newline at end of file +?> diff --git a/includes/api/ApiFormatYaml_spyc.php b/includes/api/ApiFormatYaml_spyc.php index 91155aa99c..a67bbb22aa 100644 --- a/includes/api/ApiFormatYaml_spyc.php +++ b/includes/api/ApiFormatYaml_spyc.php @@ -6,12 +6,11 @@ * @see http://spyc.sourceforge.net/ * @copyright Copyright 2005-2006 Chris Wanstrath * @license http://www.opensource.org/licenses/mit-license.php MIT License - * @addtogroup Spyc */ /** * A node, used by Spyc for parsing YAML. - * @addtogroup Spyc + * @addtogroup API */ class YAMLNode { /**#@+ @@ -59,7 +58,7 @@ * $parser = new Spyc; * $array = $parser->load($file); * - * @addtogroup Spyc + * @addtogroup API */ class Spyc { diff --git a/includes/api/ApiHelp.php b/includes/api/ApiHelp.php index 07108ced25..570c7874d4 100644 --- a/includes/api/ApiHelp.php +++ b/includes/api/ApiHelp.php @@ -1,6 +1,5 @@ \ No newline at end of file +?> diff --git a/includes/api/ApiLogin.php b/includes/api/ApiLogin.php index 954cd1974d..9a8c70ee18 100644 --- a/includes/api/ApiLogin.php +++ b/includes/api/ApiLogin.php @@ -1,6 +1,5 @@ \ No newline at end of file +?> diff --git a/includes/api/ApiPageSet.php b/includes/api/ApiPageSet.php index 1b555673bf..a99ec218e2 100644 --- a/includes/api/ApiPageSet.php +++ b/includes/api/ApiPageSet.php @@ -1,6 +1,5 @@ page_id or 0 when missing diff --git a/includes/api/ApiQuery.php b/includes/api/ApiQuery.php index 72859d8997..a42dec2349 100644 --- a/includes/api/ApiQuery.php +++ b/includes/api/ApiQuery.php @@ -1,6 +1,5 @@ \ No newline at end of file +?> diff --git a/includes/api/ApiQueryBase.php b/includes/api/ApiQueryBase.php index cc9a4fed7a..bc8c483f74 100644 --- a/includes/api/ApiQueryBase.php +++ b/includes/api/ApiQueryBase.php @@ -1,6 +1,5 @@ \ No newline at end of file +?> diff --git a/includes/api/ApiQueryRevisions.php b/includes/api/ApiQueryRevisions.php index d2c043611a..c07b938cf6 100644 --- a/includes/api/ApiQueryRevisions.php +++ b/includes/api/ApiQueryRevisions.php @@ -1,6 +1,5 @@ \ No newline at end of file +?> diff --git a/includes/api/ApiQueryUserContributions.php b/includes/api/ApiQueryUserContributions.php index d518e889d9..6f99b9d42e 100644 --- a/includes/api/ApiQueryUserContributions.php +++ b/includes/api/ApiQueryUserContributions.php @@ -1,6 +1,5 @@ \ No newline at end of file +?> diff --git a/includes/memcached-client.php b/includes/memcached-client.php index 2c5cc6be77..b42f467d88 100644 --- a/includes/memcached-client.php +++ b/includes/memcached-client.php @@ -91,7 +91,7 @@ define("COMPRESSION_SAVINGS", 0.20); * memcached client class implemented using (p)fsockopen() * * @author Ryan T. Dean - * @package memcached-client + * @addtogroup cache */ class memcached { diff --git a/includes/templates/Userlogin.php b/includes/templates/Userlogin.php index a0c3ec1d8f..ccddfa662d 100644 --- a/includes/templates/Userlogin.php +++ b/includes/templates/Userlogin.php @@ -92,6 +92,9 @@ class UserloginTemplate extends QuickTemplate { } } +/** + * @addtogroup Templates + */ class UsercreateTemplate extends QuickTemplate { function execute() { if( $this->data['message'] ) { -- 2.20.1