diff options
93 files changed, 343 insertions, 137 deletions
diff --git a/includes/AjaxDispatcher.php b/includes/AjaxDispatcher.php index bb4709bb40af..570931c87bf7 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 5f906a33eb18..98b674fe9829 100644 --- a/includes/AjaxFunctions.php +++ b/includes/AjaxFunctions.php @@ -1,5 +1,10 @@ <?php +/** + * @package MediaWiki + * @addtogroup Ajax + */ + if( !defined( 'MEDIAWIKI' ) ) die( 1 ); diff --git a/includes/AjaxResponse.php b/includes/AjaxResponse.php index a814e57d4d6b..cb4af1b57fe0 100644 --- a/includes/AjaxResponse.php +++ b/includes/AjaxResponse.php @@ -5,6 +5,7 @@ if( !defined( 'MEDIAWIKI' ) ) { /** * @todo document + * @addtogroup Ajax */ class AjaxResponse { var $mCacheDuration; diff --git a/includes/CacheDependency.php b/includes/CacheDependency.php index 5d849f5f1ea6..bb5c54375fb4 100644 --- a/includes/CacheDependency.php +++ b/includes/CacheDependency.php @@ -4,6 +4,7 @@ * This class stores an arbitrary value along with its dependencies. * Users should typically only use DependencyWrapper::getFromCache(), rather * than instantiating one of these objects directly. + * @addtogroup Cache */ class DependencyWrapper { var $value; @@ -95,6 +96,9 @@ class DependencyWrapper { } } +/** + * @addtogroup Cache + */ abstract class CacheDependency { /** * Returns true if the dependency is expired, false otherwise @@ -107,6 +111,9 @@ abstract class CacheDependency { function loadDependencyValues() {} } +/** + * @addtogroup Cache + */ class FileDependency extends CacheDependency { var $filename, $timestamp; @@ -163,6 +170,9 @@ class FileDependency extends CacheDependency { } } +/** + * @addtogroup Cache + */ class TitleDependency extends CacheDependency { var $titleObj; var $ns, $dbk; @@ -219,6 +229,9 @@ class TitleDependency extends CacheDependency { } } +/** + * @addtogroup Cache + */ class TitleListDependency extends CacheDependency { var $linkBatch; var $timestamps; @@ -299,6 +312,9 @@ class TitleListDependency extends CacheDependency { } } +/** + * @addtogroup Cache + */ class GlobalDependency extends CacheDependency { var $name, $value; @@ -312,6 +328,9 @@ class GlobalDependency extends CacheDependency { } } +/** + * @addtogroup Cache + */ class ConstantDependency extends CacheDependency { var $name, $value; diff --git a/includes/CoreParserFunctions.php b/includes/CoreParserFunctions.php index bb8a735f4b06..72ceb45f60aa 100644 --- a/includes/CoreParserFunctions.php +++ b/includes/CoreParserFunctions.php @@ -2,8 +2,8 @@ /** * Various core parser functions, registered in Parser::firstCallInit() + * @addtogroup Parser */ - class CoreParserFunctions { static function intFunction( $parser, $part1 = '' /*, ... */ ) { if ( strval( $part1 ) !== '' ) { diff --git a/includes/Database.php b/includes/Database.php index 7d5ddfe0ad15..f2042c7455f9 100644 --- a/includes/Database.php +++ b/includes/Database.php @@ -17,6 +17,7 @@ define( 'DEADLOCK_DELAY_MAX', 1500000 ); /** * Utility class. + * @addtogroup Database */ class DBObject { public $mData; @@ -36,6 +37,7 @@ class DBObject { /** * Utility class. + * @addtogroup Database */ class MySQLField { private $name, $tablename, $default, $max_length, $nullable, @@ -92,6 +94,7 @@ class MySQLField { /** * Database error base class + * @addtogroup Database */ class DBError extends MWException { public $db; @@ -107,6 +110,9 @@ class DBError extends MWException { } } +/** + * @addtogroup Database + */ class DBConnectionError extends DBError { public $error; @@ -224,6 +230,9 @@ border=\"0\" ALT=\"Google\"></A> } } +/** + * @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 9c6bb7186637..2b720df7ee5a 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 f2b982d629dc..7158e2d1610c 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 ad7ec14a933e..81cf12f6d9d1 100644 --- a/includes/Exception.php +++ b/includes/Exception.php @@ -1,5 +1,8 @@ <?php +/** + * @addtogroup Exception + */ class MWException extends Exception { function useOutputPage() { @@ -125,6 +128,7 @@ class MWException extends Exception /** * Exception class which takes an HTML error message, and does not * produce a backtrace. Replacement for OutputPage::fatalError(). + * @addtogroup Exception */ class FatalError extends MWException { function getHTML() { @@ -136,6 +140,9 @@ class FatalError extends MWException { } } +/** + * @addtogroup Exception + */ class ErrorPageError extends MWException { public $title, $msg; diff --git a/includes/Export.php b/includes/Export.php index 1582d0d33ab2..9307795d8c77 100644 --- a/includes/Export.php +++ b/includes/Export.php @@ -281,6 +281,9 @@ class WikiExporter { } } +/** + * @addtogroup Dump + */ class XmlDumpWriter { /** @@ -463,6 +466,7 @@ class XmlDumpWriter { /** * Base class for output stream; prints to stdout or buffer or whereever. + * @addtogroup Dump */ class DumpOutput { function writeOpenStream( $string ) { @@ -496,6 +500,7 @@ class DumpOutput { /** * Stream outputter to send data to a file. + * @addtogroup Dump */ class DumpFileOutput extends DumpOutput { var $handle; @@ -513,6 +518,7 @@ class DumpFileOutput extends DumpOutput { * Stream outputter to send data to a file via some filter program. * Even if compression is available in a library, using a separate * program can allow us to make use of a multi-processor system. + * @addtogroup Dump */ class DumpPipeOutput extends DumpFileOutput { function DumpPipeOutput( $command, $file = null ) { @@ -525,6 +531,7 @@ class DumpPipeOutput extends DumpFileOutput { /** * Sends dump output via the gzip compressor. + * @addtogroup Dump */ class DumpGZipOutput extends DumpPipeOutput { function DumpGZipOutput( $file ) { @@ -534,6 +541,7 @@ class DumpGZipOutput extends DumpPipeOutput { /** * Sends dump output via the bgzip2 compressor. + * @addtogroup Dump */ class DumpBZip2Output extends DumpPipeOutput { function DumpBZip2Output( $file ) { @@ -543,6 +551,7 @@ class DumpBZip2Output extends DumpPipeOutput { /** * Sends dump output via the p7zip compressor. + * @addtogroup Dump */ class Dump7ZipOutput extends DumpPipeOutput { function Dump7ZipOutput( $file ) { @@ -560,6 +569,7 @@ class Dump7ZipOutput extends DumpPipeOutput { * Dump output filter class. * This just does output filtering and streaming; XML formatting is done * higher up, so be careful in what you do. + * @addtogroup Dump */ class DumpFilter { function DumpFilter( &$sink ) { @@ -605,6 +615,7 @@ class DumpFilter { /** * Simple dump output filter to exclude all talk pages. + * @addtogroup Dump */ class DumpNotalkFilter extends DumpFilter { function pass( $page ) { @@ -614,6 +625,7 @@ class DumpNotalkFilter extends DumpFilter { /** * Dump output filter to include or exclude pages in a given set of namespaces. + * @addtogroup Dump */ class DumpNamespaceFilter extends DumpFilter { var $invert = false; @@ -668,6 +680,7 @@ class DumpNamespaceFilter extends DumpFilter { /** * Dump output filter to include only the last revision in each page sequence. + * @addtogroup Dump */ class DumpLatestFilter extends DumpFilter { var $page, $pageString, $rev, $revString; @@ -699,6 +712,7 @@ class DumpLatestFilter extends DumpFilter { /** * Base class for output stream; prints to stdout or buffer or whereever. + * @addtogroup Dump */ class DumpMultiWriter { function DumpMultiWriter( $sinks ) { diff --git a/includes/FileStore.php b/includes/FileStore.php index e9017037b507..dcec71c567d1 100644 --- a/includes/FileStore.php +++ b/includes/FileStore.php @@ -371,6 +371,9 @@ class FSTransaction { } } +/** + * @addtogroup Exception + */ class FSException extends MWException { } ?> diff --git a/includes/ImageQueryPage.php b/includes/ImageQueryPage.php index 65a50a4d9bfb..c49b487ed12a 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 <robchur@gmail.com> */ 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 938eed0a2cee..b1cf41f0de08 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 17ed57f13601..5b82ebf6b20b 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 c135e2126ba6..9c2b083cdb89 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 efaf303e529b..89ab0915b285 100644 --- a/includes/Parser.php +++ b/includes/Parser.php @@ -86,6 +86,7 @@ define( 'MW_COLON_STATE_COMMENTDASHDASH', 7 ); * * only within ParserOptions * </pre> * + * @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 752aa545f10e..ad95979c39d5 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 f165343f0d3d..e335720f3b60 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 fa2c1b61e39e..03f1819c8025 100644 --- a/includes/ParserOutput.php +++ b/includes/ParserOutput.php @@ -1,6 +1,7 @@ <?php /** * @todo document + * @addtogroup Parser */ class ParserOutput { diff --git a/includes/Profiler.php b/includes/Profiler.php index 8307690ddf3d..da3a82eda610 100644 --- a/includes/Profiler.php +++ b/includes/Profiler.php @@ -40,6 +40,7 @@ if (!function_exists('memory_get_usage')) { /** * @todo document + * @addtogroup Profiler */ class Profiler { var $mStack = array (), $mWorkStack = array (), $mCollated = array (); diff --git a/includes/ProfilerSimple.php b/includes/ProfilerSimple.php index a52af257d5ff..f43c7dfcc7ff 100644 --- a/includes/ProfilerSimple.php +++ b/includes/ProfilerSimple.php @@ -5,6 +5,7 @@ require_once(dirname(__FILE__).'/Profiler.php'); /** * Simple profiler base class. * @todo document methods (?) + * @addtogroup Profiler */ class ProfilerSimple extends Profiler { var $mMinimumTime = 0; diff --git a/includes/ProfilerSimpleUDP.php b/includes/ProfilerSimpleUDP.php index a8ca97f9bafb..500f1cbd5b00 100644 --- a/includes/ProfilerSimpleUDP.php +++ b/includes/ProfilerSimpleUDP.php @@ -6,6 +6,7 @@ require_once(dirname(__FILE__).'/ProfilerSimple.php'); /** * ProfilerSimpleUDP class, that sends out messages for 'udpprofile' daemon * (the one from mediawiki/trunk/udpprofile SVN ) + * @addtogroup Profiler */ class ProfilerSimpleUDP extends ProfilerSimple { function getFunctionReport() { diff --git a/includes/QueryPage.php b/includes/QueryPage.php index 27c6927bdd98..143c8be6c249 100644 --- a/includes/QueryPage.php +++ b/includes/QueryPage.php @@ -52,7 +52,7 @@ if ( !$wgDisableCounters ) * This is a class for doing query pages; since they're almost all the same, * we factor out some of the functionality into a superclass, and let * subclasses derive from it. - * + * @addtogroup SpecialPage */ class QueryPage { /** @@ -525,4 +525,4 @@ class QueryPage { } } -?>
\ No newline at end of file +?> diff --git a/includes/Sanitizer.php b/includes/Sanitizer.php index 96f89dce32ff..ebb0dcccaef4 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 dc10279f4d78..2ef59143028d 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 87878b6bc7a5..0e02a6845ddf 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 dbd88ecac580..97ce3850141e 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 8f1372946e6d..c9a675e6c75a 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 390fcd1fbb6e..421d9660f19e 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 e79c1d083ef7..724197c15757 100644 --- a/includes/SearchUpdate.php +++ b/includes/SearchUpdate.php @@ -1,10 +1,7 @@ <?php /** * See deferred.txt - */ - -/** - * + * @addtogroup Search */ class SearchUpdate { @@ -109,6 +106,7 @@ class SearchUpdate { /** * Placeholder class + * @addtogroup Search */ class SearchUpdateMyISAM extends SearchUpdate { # Inherits everything diff --git a/includes/SpecialAllpages.php b/includes/SpecialAllpages.php index 9b89145b8f56..03e164bd5b37 100644 --- a/includes/SpecialAllpages.php +++ b/includes/SpecialAllpages.php @@ -36,6 +36,10 @@ function wfSpecialAllpages( $par=NULL, $specialPage ) { } } +/** + * Implements Special:Allpages + * @addtogroup SpecialPage + */ class SpecialAllpages { var $maxPerPage=960; var $topLevelMax=50; diff --git a/includes/SpecialAncientpages.php b/includes/SpecialAncientpages.php index 4b52b6a68418..c0bbb7baba65 100644 --- a/includes/SpecialAncientpages.php +++ b/includes/SpecialAncientpages.php @@ -5,7 +5,7 @@ */ /** - * @todo document, briefly. + * Implements Special:Ancientpages * @addtogroup SpecialPage */ class AncientPagesPage extends QueryPage { diff --git a/includes/SpecialCategories.php b/includes/SpecialCategories.php index 1cebdcc44d09..45e1ae6cc9eb 100644 --- a/includes/SpecialCategories.php +++ b/includes/SpecialCategories.php @@ -16,6 +16,10 @@ function wfSpecialCategories() { ); } +/** + * @addtogroup SpecialPage + * @addtogroup Pager + */ class CategoryPager extends AlphabeticPager { function getQueryInfo() { return array( diff --git a/includes/SpecialConfirmemail.php b/includes/SpecialConfirmemail.php index e1feb8a47ef2..58e55899f6a0 100644 --- a/includes/SpecialConfirmemail.php +++ b/includes/SpecialConfirmemail.php @@ -1,14 +1,6 @@ <?php /** - * 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 <robchur@gmail.com> - */ - -/** * Main execution point * * @param $par Parameters passed to the page @@ -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 <robchur@gmail.com> + */ class EmailConfirmation extends SpecialPage { /** diff --git a/includes/SpecialFewestrevisions.php b/includes/SpecialFewestrevisions.php index 160f371c51db..849438f1112d 100644 --- a/includes/SpecialFewestrevisions.php +++ b/includes/SpecialFewestrevisions.php @@ -1,14 +1,12 @@ <?php /** - * * Special page for listing the articles with the fewest revisions. * * @package MediaWiki - * @subpackage Special pages + * @addtogroup SpecialPage * @author Martin Drashkov */ - class FewestrevisionsPage extends QueryPage { function getName() { @@ -64,4 +62,4 @@ function wfSpecialFewestrevisions() { $frp->doQuery( $offset, $limit ); } -?>
\ No newline at end of file +?> diff --git a/includes/SpecialImagelist.php b/includes/SpecialImagelist.php index 390fb54d049a..92b9ae1161b1 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 b6d4b0d8c8a0..22c353726ae0 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 e5c285c0c279..8cb5729e79bd 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 e761942669e7..df2b9adf2462 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 6b01d7d5ba42..9d16f389df49 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 2ba9015d4d86..ab089cf8d85b 100644 --- a/includes/SpecialMostlinked.php +++ b/includes/SpecialMostlinked.php @@ -1,7 +1,8 @@ <?php /** - * A special page to show pages ordered by the number of pages linking to them + * A special page to show pages ordered by the number of pages linking to them. + * Implements Special:Mostlinked * * @addtogroup SpecialPage * @@ -11,10 +12,6 @@ * @copyright © 2006 Rob Church * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License 2.0 or later */ - -/** - * @addtogroup SpecialPage - */ class MostlinkedPage extends QueryPage { function getName() { return 'Mostlinked'; } diff --git a/includes/SpecialMostlinkedcategories.php b/includes/SpecialMostlinkedcategories.php index 536a48a18644..725e5b39afc1 100644 --- a/includes/SpecialMostlinkedcategories.php +++ b/includes/SpecialMostlinkedcategories.php @@ -8,10 +8,6 @@ * @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 MostlinkedCategoriesPage extends QueryPage { function getName() { return 'Mostlinkedcategories'; } diff --git a/includes/SpecialNewpages.php b/includes/SpecialNewpages.php index f20f9dff16f2..48037a7347a7 100644 --- a/includes/SpecialNewpages.php +++ b/includes/SpecialNewpages.php @@ -5,7 +5,7 @@ */ /** - * + * implements Special:Newpages * @addtogroup SpecialPage */ class NewPagesPage extends QueryPage { diff --git a/includes/SpecialPage.php b/includes/SpecialPage.php index 4bcdf8a11155..faf45176d960 100644 --- a/includes/SpecialPage.php +++ b/includes/SpecialPage.php @@ -26,7 +26,8 @@ /** * Parent special page class, also static functions for handling the special - * page list + * page list. + * @addtogroup SpecialPage */ class SpecialPage { @@ -692,6 +693,7 @@ class SpecialPage /** * Shortcut to construct a special page which is unlisted by default + * @addtogroup SpecialPage */ class UnlistedSpecialPage extends SpecialPage { @@ -702,6 +704,7 @@ class UnlistedSpecialPage extends SpecialPage /** * Shortcut to construct an includable special page + * @addtogroup SpecialPage */ class IncludableSpecialPage extends SpecialPage { @@ -710,6 +713,9 @@ class IncludableSpecialPage extends SpecialPage } } +/** + * @addtogroup SpecialPage + */ class SpecialRedirectToSpecial extends UnlistedSpecialPage { var $redirName, $redirSubpage; @@ -729,6 +735,9 @@ class SpecialRedirectToSpecial extends UnlistedSpecialPage { } } +/** + * @addtogroup SpecialPage + */ class SpecialMypage extends UnlistedSpecialPage { function __construct() { parent::__construct( 'Mypage' ); @@ -745,6 +754,9 @@ class SpecialMypage extends UnlistedSpecialPage { } } +/** + * @addtogroup SpecialPage + */ class SpecialMytalk extends UnlistedSpecialPage { function __construct() { parent::__construct( 'Mytalk' ); @@ -761,6 +773,9 @@ class SpecialMytalk extends UnlistedSpecialPage { } } +/** + * @addtogroup SpecialPage + */ class SpecialMycontributions extends UnlistedSpecialPage { function __construct() { parent::__construct( 'Mycontributions' ); diff --git a/includes/SpecialPopularpages.php b/includes/SpecialPopularpages.php index e0e4a47d4229..d5d6aeea1222 100644 --- a/includes/SpecialPopularpages.php +++ b/includes/SpecialPopularpages.php @@ -5,7 +5,7 @@ */ /** - * + * implements Special:Popularpages * @addtogroup SpecialPage */ class PopularPagesPage extends QueryPage { diff --git a/includes/SpecialPrefixindex.php b/includes/SpecialPrefixindex.php index fc14d7ab3cfc..b7c51d49c8a6 100644 --- a/includes/SpecialPrefixindex.php +++ b/includes/SpecialPrefixindex.php @@ -41,6 +41,10 @@ function wfSpecialPrefixIndex( $par=NULL, $specialPage ) { } } +/** + * implements Special:Prefixindex + * @addtogroup SpecialPage + */ class SpecialPrefixindex extends SpecialAllpages { var $maxPerPage=960; var $topLevelMax=50; diff --git a/includes/SpecialProtectedpages.php b/includes/SpecialProtectedpages.php index b214822da271..91b138ff40f6 100644 --- a/includes/SpecialProtectedpages.php +++ b/includes/SpecialProtectedpages.php @@ -186,6 +186,7 @@ class ProtectedPagesForm { /** * @todo document + * @addtogroup Pager */ class ProtectedPagesPager extends ReverseChronologicalPager { public $mForm, $mConds; diff --git a/includes/SpecialRandompage.php b/includes/SpecialRandompage.php index bf39ca6f7a8f..e6c4abe8299d 100644 --- a/includes/SpecialRandompage.php +++ b/includes/SpecialRandompage.php @@ -31,6 +31,11 @@ function wfSpecialRandompage( $par = null ) { } +/** + * Special page to direct the user to a random page + * + * @addtogroup SpecialPage + */ class RandomPage { private $namespace = NS_MAIN; // namespace to select pages from private $redirect = false; // select redirects instead of normal pages? diff --git a/includes/SpecialResetpass.php b/includes/SpecialResetpass.php index e16a2fb6bad0..3ae79f8a21af 100644 --- a/includes/SpecialResetpass.php +++ b/includes/SpecialResetpass.php @@ -5,6 +5,9 @@ function wfSpecialResetpass( $par ) { $form->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 fb5e9ec8c41d..5c70d5aed0b1 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 e96c87535190..fdaa8541a5a2 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 4d4941ffd3f3..e02c9bbdce7d 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 b4fb403db8fc..6b99192a4016 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 033066dbcf96..8b72e8a7dcfb 100644 --- a/includes/SpecialUnusedtemplates.php +++ b/includes/SpecialUnusedtemplates.php @@ -1,6 +1,7 @@ <?php /** + * implements Special:Unusedtemplates * @author Rob Church <robchur@gmail.com> * @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 6d067f374294..fed0b5906a6b 100644 --- a/includes/SpecialUnwatchedpages.php +++ b/includes/SpecialUnwatchedpages.php @@ -1,17 +1,13 @@ <?php /** - * A special page that displays a list of pages that are not on anyones watchlist + * A special page that displays a list of pages that are not on anyones watchlist. + * Implements Special:Unwatchedpages * * @addtogroup SpecialPage - * * @author Ævar Arnfjörð Bjarmason <avarab@gmail.com> * @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 af4070a68653..2d6e6baceb32 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 fb4ae5325b6b..9450d22b5e85 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 a5f252103906..ff3abc5767c1 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 eab44d6bd2c0..27a9f1764928 100644 --- a/includes/SpecialWantedcategories.php +++ b/includes/SpecialWantedcategories.php @@ -1,6 +1,6 @@ <?php /** - * A querypage to list the most wanted categories + * A querypage to list the most wanted categories - implements Special:Wantedcategories * * @addtogroup SpecialPage * @@ -8,10 +8,6 @@ * @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 WantedCategoriesPage extends QueryPage { function getName() { return 'Wantedcategories'; } diff --git a/includes/SpecialWantedpages.php b/includes/SpecialWantedpages.php index 06e959e3105d..8b7002092417 100644 --- a/includes/SpecialWantedpages.php +++ b/includes/SpecialWantedpages.php @@ -5,7 +5,7 @@ */ /** - * + * implements Special:Wantedpages * @addtogroup SpecialPage */ class WantedPagesPage extends QueryPage { diff --git a/includes/SpecialWhatlinkshere.php b/includes/SpecialWhatlinkshere.php index f077cca79fd8..dff036a1d0b7 100644 --- a/includes/SpecialWhatlinkshere.php +++ b/includes/SpecialWhatlinkshere.php @@ -14,6 +14,10 @@ function wfSpecialWhatlinkshere($par = NULL) { $page->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 1567b290bd0c..e5341d5df436 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 <robchur@gmail.com> */ 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 56d4cccd9d5b..d0c2db68a390 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 1b3f7f0aa967..064db61a765f 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 a29e3360cc82..a8b1939958f0 100644 --- a/includes/api/ApiBase.php +++ b/includes/api/ApiBase.php @@ -1,6 +1,5 @@ <?php - /* * Created on Sep 5, 2006 * @@ -26,6 +25,7 @@ /** * @todo Document - e.g. Provide top-level description of this class. + * @addtogroup API */ abstract class ApiBase { @@ -533,4 +533,4 @@ abstract class ApiBase { return __CLASS__ . ': $Id$'; } } -?>
\ No newline at end of file +?> diff --git a/includes/api/ApiFeedWatchlist.php b/includes/api/ApiFeedWatchlist.php index 335df324b7f8..97d1f7989791 100644 --- a/includes/api/ApiFeedWatchlist.php +++ b/includes/api/ApiFeedWatchlist.php @@ -1,6 +1,5 @@ <?php - /* * Created on Oct 13, 2006 * @@ -29,6 +28,9 @@ if (!defined('MEDIAWIKI')) { require_once ("ApiBase.php"); } +/** + * @addtogroup API + */ class ApiFeedWatchlist extends ApiBase { public function __construct($main, $action) { diff --git a/includes/api/ApiFormatBase.php b/includes/api/ApiFormatBase.php index 1ed71a6f914f..082433887fbf 100644 --- a/includes/api/ApiFormatBase.php +++ b/includes/api/ApiFormatBase.php @@ -1,6 +1,5 @@ <?php - /* * Created on Sep 19, 2006 * @@ -29,6 +28,9 @@ if (!defined('MEDIAWIKI')) { require_once ('ApiBase.php'); } +/** + * @addtogroup API + */ abstract class ApiFormatBase extends ApiBase { private $mIsHtml, $mFormat; @@ -176,6 +178,7 @@ for more information. /** * This printer is used to wrap an instance of the Feed class + * @addtogroup API */ class ApiFormatFeedWrapper extends ApiFormatBase { diff --git a/includes/api/ApiFormatJson.php b/includes/api/ApiFormatJson.php index 06dc99bbd68a..99979d207d88 100644 --- a/includes/api/ApiFormatJson.php +++ b/includes/api/ApiFormatJson.php @@ -1,6 +1,5 @@ <?php - /* * Created on Sep 19, 2006 * @@ -29,6 +28,9 @@ if (!defined('MEDIAWIKI')) { require_once ('ApiFormatBase.php'); } +/** + * @addtogroup API + */ class ApiFormatJson extends ApiFormatBase { private $mIsRaw; @@ -66,4 +68,4 @@ class ApiFormatJson extends ApiFormatBase { return __CLASS__ . ': $Id$'; } } -?>
\ No newline at end of file +?> diff --git a/includes/api/ApiFormatJson_json.php b/includes/api/ApiFormatJson_json.php index c15cdd8003d8..2cd87930b342 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 <mike-json@teczno.com> * @author Matt Knapp <mdknapp[at]gmail[dot]com> * @author Brett Stimmerman <brettstimmerman[at]gmail[dot]com> @@ -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: -* -* <code> -* // 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); -* </code> -*/ + * Converts to and from JSON format. + * + * Brief example of use: + * + * <code> + * // 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); + * </code> + * + * @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 f635f4ca797a..20480b6df49f 100644 --- a/includes/api/ApiFormatPhp.php +++ b/includes/api/ApiFormatPhp.php @@ -1,6 +1,5 @@ <?php - /* * Created on Oct 22, 2006 * @@ -29,6 +28,9 @@ if (!defined('MEDIAWIKI')) { require_once ('ApiFormatBase.php'); } +/** + * @addtogroup API + */ class ApiFormatPhp extends ApiFormatBase { public function __construct($main, $format) { @@ -51,4 +53,4 @@ class ApiFormatPhp extends ApiFormatBase { return __CLASS__ . ': $Id$'; } } -?>
\ No newline at end of file +?> diff --git a/includes/api/ApiFormatWddx.php b/includes/api/ApiFormatWddx.php index 71f13d4a3ae4..ad902b630cbb 100644 --- a/includes/api/ApiFormatWddx.php +++ b/includes/api/ApiFormatWddx.php @@ -1,6 +1,5 @@ <?php - /* * Created on Oct 22, 2006 * @@ -29,6 +28,9 @@ if (!defined('MEDIAWIKI')) { require_once ('ApiFormatBase.php'); } +/** + * @addtogroup API + */ class ApiFormatWddx extends ApiFormatBase { public function __construct($main, $format) { @@ -86,4 +88,4 @@ class ApiFormatWddx extends ApiFormatBase { return __CLASS__ . ': $Id$'; } } -?>
\ No newline at end of file +?> diff --git a/includes/api/ApiFormatXml.php b/includes/api/ApiFormatXml.php index 5d4e776f4a34..0c81c2fc9c68 100644 --- a/includes/api/ApiFormatXml.php +++ b/includes/api/ApiFormatXml.php @@ -1,6 +1,5 @@ <?php - /* * Created on Sep 19, 2006 * @@ -29,6 +28,9 @@ if (!defined('MEDIAWIKI')) { require_once ('ApiFormatBase.php'); } +/** + * @addtogroup API + */ class ApiFormatXml extends ApiFormatBase { private $mRootElemName = 'api'; @@ -142,4 +144,4 @@ class ApiFormatXml extends ApiFormatBase { return __CLASS__ . ': $Id$'; } } -?>
\ No newline at end of file +?> diff --git a/includes/api/ApiFormatYaml.php b/includes/api/ApiFormatYaml.php index 006e9733a035..5fc89b9a4061 100644 --- a/includes/api/ApiFormatYaml.php +++ b/includes/api/ApiFormatYaml.php @@ -1,6 +1,5 @@ <?php - /* * Created on Sep 19, 2006 * @@ -29,6 +28,9 @@ if (!defined('MEDIAWIKI')) { require_once ('ApiFormatBase.php'); } +/** + * @addtogroup API + */ class ApiFormatYaml extends ApiFormatBase { public function __construct($main, $format) { @@ -51,4 +53,4 @@ class ApiFormatYaml extends ApiFormatBase { return __CLASS__ . ': $Id$'; } } -?>
\ No newline at end of file +?> diff --git a/includes/api/ApiFormatYaml_spyc.php b/includes/api/ApiFormatYaml_spyc.php index 91155aa99cad..a67bbb22aad0 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); * </code> - * @addtogroup Spyc + * @addtogroup API */ class Spyc { diff --git a/includes/api/ApiHelp.php b/includes/api/ApiHelp.php index 07108ced2541..570c7874d45c 100644 --- a/includes/api/ApiHelp.php +++ b/includes/api/ApiHelp.php @@ -1,6 +1,5 @@ <?php - /* * Created on Sep 6, 2006 * @@ -29,6 +28,9 @@ if (!defined('MEDIAWIKI')) { require_once ('ApiBase.php'); } +/** + * @addtogroup API + */ class ApiHelp extends ApiBase { public function __construct($main, $action) { @@ -52,4 +54,4 @@ class ApiHelp extends ApiBase { return __CLASS__ . ': $Id$'; } } -?>
\ No newline at end of file +?> diff --git a/includes/api/ApiLogin.php b/includes/api/ApiLogin.php index 954cd1974d15..9a8c70ee1805 100644 --- a/includes/api/ApiLogin.php +++ b/includes/api/ApiLogin.php @@ -1,6 +1,5 @@ <?php - /* * Created on Sep 19, 2006 * @@ -29,6 +28,9 @@ if (!defined('MEDIAWIKI')) { require_once ('ApiBase.php'); } +/** + * @addtogroup API + */ class ApiLogin extends ApiBase { public function __construct($main, $action) { diff --git a/includes/api/ApiMain.php b/includes/api/ApiMain.php index 214cfc747d12..c4d5a8393047 100644 --- a/includes/api/ApiMain.php +++ b/includes/api/ApiMain.php @@ -1,6 +1,5 @@ <?php - /* * Created on Sep 4, 2006 * @@ -31,6 +30,7 @@ if (!defined('MEDIAWIKI')) { /** * This is the main API class, used for both external and internal processing. + * @addtogroup API */ class ApiMain extends ApiBase { @@ -347,6 +347,7 @@ class ApiMain extends ApiBase { /** * This exception will be thrown when dieUsage is called to stop module execution. + * @addtogroup API */ class UsageException extends Exception { diff --git a/includes/api/ApiOpenSearch.php b/includes/api/ApiOpenSearch.php index 3bbcf4e24dcf..48d6b1373c59 100644 --- a/includes/api/ApiOpenSearch.php +++ b/includes/api/ApiOpenSearch.php @@ -1,6 +1,5 @@ <?php - /* * Created on Oct 13, 2006 * @@ -29,6 +28,9 @@ if (!defined('MEDIAWIKI')) { require_once ("ApiBase.php"); } +/** + * @addtogroup API + */ class ApiOpenSearch extends ApiBase { public function __construct($main, $action) { @@ -106,4 +108,4 @@ class ApiOpenSearch extends ApiBase { return __CLASS__ . ': $Id$'; } } -?>
\ No newline at end of file +?> diff --git a/includes/api/ApiPageSet.php b/includes/api/ApiPageSet.php index 1b555673bff9..a99ec218e2fe 100644 --- a/includes/api/ApiPageSet.php +++ b/includes/api/ApiPageSet.php @@ -1,6 +1,5 @@ <?php - /* * Created on Sep 24, 2006 * @@ -29,6 +28,9 @@ if (!defined('MEDIAWIKI')) { require_once ('ApiQueryBase.php'); } +/** + * @addtogroup API + */ class ApiPageSet extends ApiQueryBase { private $mAllPages; // [ns][dbkey] => page_id or 0 when missing diff --git a/includes/api/ApiQuery.php b/includes/api/ApiQuery.php index 72859d89975e..a42dec23498a 100644 --- a/includes/api/ApiQuery.php +++ b/includes/api/ApiQuery.php @@ -1,6 +1,5 @@ <?php - /* * Created on Sep 7, 2006 * @@ -29,6 +28,9 @@ if (!defined('MEDIAWIKI')) { require_once ('ApiBase.php'); } +/** + * @addtogroup API + */ class ApiQuery extends ApiBase { private $mPropModuleNames, $mListModuleNames, $mMetaModuleNames; diff --git a/includes/api/ApiQueryAllpages.php b/includes/api/ApiQueryAllpages.php index df137d39ce5e..02f5e116f7ac 100644 --- a/includes/api/ApiQueryAllpages.php +++ b/includes/api/ApiQueryAllpages.php @@ -1,6 +1,5 @@ <?php - /* * Created on Sep 25, 2006 * @@ -29,6 +28,9 @@ if (!defined('MEDIAWIKI')) { require_once ('ApiQueryBase.php'); } +/** + * @addtogroup API + */ class ApiQueryAllpages extends ApiQueryGeneratorBase { public function __construct($query, $moduleName) { diff --git a/includes/api/ApiQueryBacklinks.php b/includes/api/ApiQueryBacklinks.php index a799c7d74f15..677ead47802a 100644 --- a/includes/api/ApiQueryBacklinks.php +++ b/includes/api/ApiQueryBacklinks.php @@ -1,6 +1,5 @@ <?php - /* * Created on Oct 16, 2006 * @@ -29,6 +28,9 @@ if (!defined('MEDIAWIKI')) { require_once ("ApiQueryBase.php"); } +/** + * @addtogroup API + */ class ApiQueryBacklinks extends ApiQueryGeneratorBase { private $rootTitle, $contRedirs, $contLevel, $contTitle, $contID; @@ -355,4 +357,4 @@ class ApiQueryBacklinks extends ApiQueryGeneratorBase { return __CLASS__ . ': $Id$'; } } -?>
\ No newline at end of file +?> diff --git a/includes/api/ApiQueryBase.php b/includes/api/ApiQueryBase.php index cc9a4fed7a85..bc8c483f7432 100644 --- a/includes/api/ApiQueryBase.php +++ b/includes/api/ApiQueryBase.php @@ -1,6 +1,5 @@ <?php - /* * Created on Sep 7, 2006 * @@ -29,6 +28,9 @@ if (!defined('MEDIAWIKI')) { require_once ('ApiBase.php'); } +/** + * @addtogroup API + */ abstract class ApiQueryBase extends ApiBase { private $mQueryModule, $tables, $where, $fields, $options; @@ -341,6 +343,9 @@ abstract class ApiQueryBase extends ApiBase { } } +/** + * @addtogroup API + */ abstract class ApiQueryGeneratorBase extends ApiQueryBase { private $mIsGenerator; diff --git a/includes/api/ApiQueryInfo.php b/includes/api/ApiQueryInfo.php index 07928b501296..3014fec12daa 100644 --- a/includes/api/ApiQueryInfo.php +++ b/includes/api/ApiQueryInfo.php @@ -1,6 +1,5 @@ <?php - /* * Created on Sep 25, 2006 * @@ -29,6 +28,9 @@ if (!defined('MEDIAWIKI')) { require_once ('ApiQueryBase.php'); } +/** + * @addtogroup API + */ class ApiQueryInfo extends ApiQueryBase { public function __construct($query, $moduleName) { diff --git a/includes/api/ApiQueryLogEvents.php b/includes/api/ApiQueryLogEvents.php index 73e0c8452f6b..3142c9e0966d 100644 --- a/includes/api/ApiQueryLogEvents.php +++ b/includes/api/ApiQueryLogEvents.php @@ -1,6 +1,5 @@ <?php - /* * Created on Oct 16, 2006 * @@ -29,6 +28,9 @@ if (!defined('MEDIAWIKI')) { require_once ('ApiQueryBase.php'); } +/** + * @addtogroup API + */ class ApiQueryLogEvents extends ApiQueryBase { public function __construct($query, $moduleName) { diff --git a/includes/api/ApiQueryRecentChanges.php b/includes/api/ApiQueryRecentChanges.php index b1cf4102f87c..cec0fb5e4621 100644 --- a/includes/api/ApiQueryRecentChanges.php +++ b/includes/api/ApiQueryRecentChanges.php @@ -1,6 +1,5 @@ <?php - /* * Created on Oct 19, 2006 * @@ -29,6 +28,9 @@ if (!defined('MEDIAWIKI')) { require_once ('ApiQueryBase.php'); } +/** + * @addtogroup API + */ class ApiQueryRecentChanges extends ApiQueryBase { public function __construct($query, $moduleName) { @@ -184,4 +186,4 @@ class ApiQueryRecentChanges extends ApiQueryBase { return __CLASS__ . ': $Id$'; } } -?>
\ No newline at end of file +?> diff --git a/includes/api/ApiQueryRevisions.php b/includes/api/ApiQueryRevisions.php index d2c043611ac4..c07b938cf607 100644 --- a/includes/api/ApiQueryRevisions.php +++ b/includes/api/ApiQueryRevisions.php @@ -1,6 +1,5 @@ <?php - /* * Created on Sep 7, 2006 * @@ -29,6 +28,9 @@ if (!defined('MEDIAWIKI')) { require_once ('ApiQueryBase.php'); } +/** + * @addtogroup API + */ class ApiQueryRevisions extends ApiQueryBase { public function __construct($query, $moduleName) { diff --git a/includes/api/ApiQuerySiteinfo.php b/includes/api/ApiQuerySiteinfo.php index ea9601f770d6..f174782c1646 100644 --- a/includes/api/ApiQuerySiteinfo.php +++ b/includes/api/ApiQuerySiteinfo.php @@ -1,6 +1,5 @@ <?php - /* * Created on Sep 25, 2006 * @@ -29,6 +28,9 @@ if (!defined('MEDIAWIKI')) { require_once ('ApiQueryBase.php'); } +/** + * @addtogroup API + */ class ApiQuerySiteinfo extends ApiQueryBase { public function __construct($query, $moduleName) { @@ -113,4 +115,4 @@ class ApiQuerySiteinfo extends ApiQueryBase { return __CLASS__ . ': $Id$'; } } -?>
\ No newline at end of file +?> diff --git a/includes/api/ApiQueryUserContributions.php b/includes/api/ApiQueryUserContributions.php index d518e889d9ac..6f99b9d42e6d 100644 --- a/includes/api/ApiQueryUserContributions.php +++ b/includes/api/ApiQueryUserContributions.php @@ -1,6 +1,5 @@ <?php - /* * Created on Oct 16, 2006 * @@ -29,6 +28,9 @@ if (!defined('MEDIAWIKI')) { require_once ('ApiQueryBase.php'); } +/** + * @addtogroup API + */ class ApiQueryContributions extends ApiQueryBase { public function __construct($query, $moduleName) { diff --git a/includes/api/ApiQueryWatchlist.php b/includes/api/ApiQueryWatchlist.php index e2557e95fe70..99e7151efcff 100644 --- a/includes/api/ApiQueryWatchlist.php +++ b/includes/api/ApiQueryWatchlist.php @@ -1,6 +1,5 @@ <?php - /* * Created on Sep 25, 2006 * @@ -29,6 +28,9 @@ if (!defined('MEDIAWIKI')) { require_once ('ApiQueryBase.php'); } +/** + * @addtogroup API + */ class ApiQueryWatchlist extends ApiQueryGeneratorBase { public function __construct($query, $moduleName) { diff --git a/includes/api/ApiResult.php b/includes/api/ApiResult.php index b56d7ac65807..65f17e8b4102 100644 --- a/includes/api/ApiResult.php +++ b/includes/api/ApiResult.php @@ -1,6 +1,5 @@ <?php - /* * Created on Sep 4, 2006 * @@ -29,6 +28,9 @@ if (!defined('MEDIAWIKI')) { require_once ('ApiBase.php'); } +/** + * @addtogroup API + */ class ApiResult extends ApiBase { private $mData, $mIsRawMode; @@ -154,4 +156,4 @@ class ApiResult extends ApiBase { return __CLASS__ . ': $Id$'; } } -?>
\ No newline at end of file +?> diff --git a/includes/memcached-client.php b/includes/memcached-client.php index 2c5cc6be776a..b42f467d88eb 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 <rtdean@cytherianage.net> - * @package memcached-client + * @addtogroup cache */ class memcached { diff --git a/includes/templates/Userlogin.php b/includes/templates/Userlogin.php index a0c3ec1d8f48..ccddfa662ded 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'] ) { |