| Index: trunk/phase3/includes/DatabasePostgres.php |
| — | — | @@ -7,8 +7,8 @@ |
| 8 | 8 | * than MySQL ones, some of them should be moved to parent |
| 9 | 9 | * Database class. |
| 10 | 10 | * |
| | 11 | + * @addtogroup Database |
| 11 | 12 | */ |
| 12 | | - |
| 13 | 13 | class PostgresField { |
| 14 | 14 | private $name, $tablename, $type, $nullable, $max_length; |
| 15 | 15 | |
| — | — | @@ -63,6 +63,9 @@ |
| 64 | 64 | } |
| 65 | 65 | } |
| 66 | 66 | |
| | 67 | +/** |
| | 68 | + * @addtogroup Database |
| | 69 | + */ |
| 67 | 70 | class DatabasePostgres extends Database { |
| 68 | 71 | var $mInsertId = NULL; |
| 69 | 72 | var $mLastResult = NULL; |
| Index: trunk/phase3/includes/SpecialWhatlinkshere.php |
| — | — | @@ -14,6 +14,10 @@ |
| 15 | 15 | $page->execute(); |
| 16 | 16 | } |
| 17 | 17 | |
| | 18 | +/** |
| | 19 | + * implements Special:Whatlinkshere |
| | 20 | + * @addtogroup SpecialPage |
| | 21 | + */ |
| 18 | 22 | class WhatLinksHerePage { |
| 19 | 23 | var $request, $par; |
| 20 | 24 | var $limit, $from, $back, $target, $namespace; |
| Index: trunk/phase3/includes/SpecialImport.php |
| — | — | @@ -160,6 +160,7 @@ |
| 161 | 161 | |
| 162 | 162 | /** |
| 163 | 163 | * Reporting callback |
| | 164 | + * @addtogroup SpecialPage |
| 164 | 165 | */ |
| 165 | 166 | class ImportReporter { |
| 166 | 167 | function __construct( $importer, $upload, $interwiki ) { |
| — | — | @@ -383,7 +384,7 @@ |
| 384 | 385 | } |
| 385 | 386 | |
| 386 | 387 | /** |
| 387 | | - * |
| | 388 | + * implements Special:Import |
| 388 | 389 | * @addtogroup SpecialPage |
| 389 | 390 | */ |
| 390 | 391 | class WikiImporter { |
| — | — | @@ -792,6 +793,7 @@ |
| 793 | 794 | |
| 794 | 795 | /** |
| 795 | 796 | * @todo document (e.g. one-sentence class description). |
| | 797 | + * @addtogroup SpecialPage |
| 796 | 798 | */ |
| 797 | 799 | class ImportStringSource { |
| 798 | 800 | function ImportStringSource( $string ) { |
| — | — | @@ -815,6 +817,7 @@ |
| 816 | 818 | |
| 817 | 819 | /** |
| 818 | 820 | * @todo document (e.g. one-sentence class description). |
| | 821 | + * @addtogroup SpecialPage |
| 819 | 822 | */ |
| 820 | 823 | class ImportStreamSource { |
| 821 | 824 | function ImportStreamSource( $handle ) { |
| Index: trunk/phase3/includes/SpecialCategories.php |
| — | — | @@ -16,6 +16,10 @@ |
| 17 | 17 | ); |
| 18 | 18 | } |
| 19 | 19 | |
| | 20 | +/** |
| | 21 | + * @addtogroup SpecialPage |
| | 22 | + * @addtogroup Pager |
| | 23 | + */ |
| 20 | 24 | class CategoryPager extends AlphabeticPager { |
| 21 | 25 | function getQueryInfo() { |
| 22 | 26 | return array( |
| Index: trunk/phase3/includes/SpecialMostcategories.php |
| — | — | @@ -8,6 +8,7 @@ |
| 9 | 9 | */ |
| 10 | 10 | |
| 11 | 11 | /** |
| | 12 | + * implements Special:Mostcategories |
| 12 | 13 | * @addtogroup SpecialPage |
| 13 | 14 | */ |
| 14 | 15 | class MostcategoriesPage extends QueryPage { |
| Index: trunk/phase3/includes/SpecialWantedcategories.php |
| — | — | @@ -1,6 +1,6 @@ |
| 2 | 2 | <?php |
| 3 | 3 | /** |
| 4 | | - * A querypage to list the most wanted categories |
| | 4 | + * A querypage to list the most wanted categories - implements Special:Wantedcategories |
| 5 | 5 | * |
| 6 | 6 | * @addtogroup SpecialPage |
| 7 | 7 | * |
| — | — | @@ -8,10 +8,6 @@ |
| 9 | 9 | * @copyright Copyright © 2005, Ævar Arnfjörð Bjarmason |
| 10 | 10 | * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License 2.0 or later |
| 11 | 11 | */ |
| 12 | | - |
| 13 | | -/** |
| 14 | | - * @addtogroup SpecialPage |
| 15 | | - */ |
| 16 | 12 | class WantedCategoriesPage extends QueryPage { |
| 17 | 13 | |
| 18 | 14 | function getName() { return 'Wantedcategories'; } |
| Index: trunk/phase3/includes/DatabaseOracle.php |
| — | — | @@ -2,6 +2,7 @@ |
| 3 | 3 | |
| 4 | 4 | /** |
| 5 | 5 | * This is the Oracle database abstraction layer. |
| | 6 | + * @addtogroup Database |
| 6 | 7 | */ |
| 7 | 8 | class ORABlob { |
| 8 | 9 | var $mData; |
| — | — | @@ -19,6 +20,7 @@ |
| 20 | 21 | * The oci8 extension is fairly weak and doesn't support oci_num_rows, among |
| 21 | 22 | * other things. We use a wrapper class to handle that and other |
| 22 | 23 | * Oracle-specific bits, like converting column names back to lowercase. |
| | 24 | + * @addtogroup Database |
| 23 | 25 | */ |
| 24 | 26 | class ORAResult { |
| 25 | 27 | private $rows; |
| — | — | @@ -82,8 +84,11 @@ |
| 83 | 85 | } |
| 84 | 86 | return $ret; |
| 85 | 87 | } |
| 86 | | -}; |
| | 88 | +} |
| 87 | 89 | |
| | 90 | +/** |
| | 91 | + * @addtogroup Database |
| | 92 | + */ |
| 88 | 93 | class DatabaseOracle extends Database { |
| 89 | 94 | var $mInsertId = NULL; |
| 90 | 95 | var $mLastResult = NULL; |
| — | — | @@ -384,7 +389,7 @@ |
| 385 | 390 | } |
| 386 | 391 | |
| 387 | 392 | /** |
| 388 | | - * ORacle does not have a "USE INDEX" clause, so return an empty string |
| | 393 | + * Oracle does not have a "USE INDEX" clause, so return an empty string |
| 389 | 394 | */ |
| 390 | 395 | function useIndexClause($index) { |
| 391 | 396 | return ''; |
| Index: trunk/phase3/includes/SearchEngine.php |
| — | — | @@ -3,9 +3,6 @@ |
| 4 | 4 | * Contain a class for special pages |
| 5 | 5 | * @addtogroup Search |
| 6 | 6 | */ |
| 7 | | - |
| 8 | | -/** |
| 9 | | - */ |
| 10 | 7 | class SearchEngine { |
| 11 | 8 | var $limit = 10; |
| 12 | 9 | var $offset = 0; |
| — | — | @@ -236,6 +233,10 @@ |
| 237 | 234 | } |
| 238 | 235 | } |
| 239 | 236 | |
| | 237 | + |
| | 238 | +/** |
| | 239 | + * @addtogroup Search |
| | 240 | + */ |
| 240 | 241 | class SearchResultSet { |
| 241 | 242 | /** |
| 242 | 243 | * Fetch an array of regular expression fragments for matching |
| — | — | @@ -310,6 +311,10 @@ |
| 311 | 312 | } |
| 312 | 313 | } |
| 313 | 314 | |
| | 315 | + |
| | 316 | +/** |
| | 317 | + * @addtogroup Search |
| | 318 | + */ |
| 314 | 319 | class SearchResult { |
| 315 | 320 | function SearchResult( $row ) { |
| 316 | 321 | $this->mTitle = Title::makeTitle( $row->page_namespace, $row->page_title ); |
| — | — | @@ -332,6 +337,7 @@ |
| 333 | 338 | } |
| 334 | 339 | |
| 335 | 340 | /** |
| | 341 | + * @addtogroup Search |
| 336 | 342 | */ |
| 337 | 343 | class SearchEngineDummy { |
| 338 | 344 | function search( $term ) { |
| Index: trunk/phase3/includes/ImageQueryPage.php |
| — | — | @@ -5,6 +5,7 @@ |
| 6 | 6 | * suited for reports generating images |
| 7 | 7 | * |
| 8 | 8 | * @package MediaWiki |
| | 9 | + * @addtogroup SpecialPage |
| 9 | 10 | * @author Rob Church <robchur@gmail.com> |
| 10 | 11 | */ |
| 11 | 12 | class ImageQueryPage extends QueryPage { |
| — | — | @@ -63,4 +64,4 @@ |
| 64 | 65 | |
| 65 | 66 | } |
| 66 | 67 | |
| 67 | | -?> |
| \ No newline at end of file |
| | 68 | +?> |
| Index: trunk/phase3/includes/SpecialConfirmemail.php |
| — | — | @@ -1,14 +1,6 @@ |
| 2 | 2 | <?php |
| 3 | 3 | |
| 4 | 4 | /** |
| 5 | | - * Special page allows users to request email confirmation message, and handles |
| 6 | | - * processing of the confirmation code when the link in the email is followed |
| 7 | | - * |
| 8 | | - * @addtogroup SpecialPage |
| 9 | | - * @author Rob Church <robchur@gmail.com> |
| 10 | | - */ |
| 11 | | - |
| 12 | | -/** |
| 13 | 5 | * Main execution point |
| 14 | 6 | * |
| 15 | 7 | * @param $par Parameters passed to the page |
| — | — | @@ -18,6 +10,13 @@ |
| 19 | 11 | $form->execute( $par ); |
| 20 | 12 | } |
| 21 | 13 | |
| | 14 | +/** |
| | 15 | + * Special page allows users to request email confirmation message, and handles |
| | 16 | + * processing of the confirmation code when the link in the email is followed |
| | 17 | + * |
| | 18 | + * @addtogroup SpecialPage |
| | 19 | + * @author Rob Church <robchur@gmail.com> |
| | 20 | + */ |
| 22 | 21 | class EmailConfirmation extends SpecialPage { |
| 23 | 22 | |
| 24 | 23 | /** |
| Index: trunk/phase3/includes/WikiError.php |
| — | — | @@ -24,6 +24,7 @@ |
| 25 | 25 | /** |
| 26 | 26 | * Since PHP4 doesn't have exceptions, here's some error objects |
| 27 | 27 | * loosely modeled on the standard PEAR_Error model... |
| | 28 | + * @addtogroup Exception |
| 28 | 29 | */ |
| 29 | 30 | class WikiError { |
| 30 | 31 | /** |
| — | — | @@ -64,6 +65,7 @@ |
| 65 | 66 | |
| 66 | 67 | /** |
| 67 | 68 | * Localized error message object |
| | 69 | + * @addtogroup Exception |
| 68 | 70 | */ |
| 69 | 71 | class WikiErrorMsg extends WikiError { |
| 70 | 72 | /** |
| — | — | @@ -79,6 +81,7 @@ |
| 80 | 82 | |
| 81 | 83 | /** |
| 82 | 84 | * @todo document |
| | 85 | + * @addtogroup Exception |
| 83 | 86 | */ |
| 84 | 87 | class WikiXmlError extends WikiError { |
| 85 | 88 | /** |
| Index: trunk/phase3/includes/SpecialIpblocklist.php |
| — | — | @@ -45,7 +45,7 @@ |
| 46 | 46 | } |
| 47 | 47 | |
| 48 | 48 | /** |
| 49 | | - * @todo document |
| | 49 | + * implements Special:ipblocklist GUI |
| 50 | 50 | * @addtogroup SpecialPage |
| 51 | 51 | */ |
| 52 | 52 | class IPUnblockForm { |
| — | — | @@ -321,6 +321,7 @@ |
| 322 | 322 | |
| 323 | 323 | /** |
| 324 | 324 | * @todo document |
| | 325 | + * @addtogroup Pager |
| 325 | 326 | */ |
| 326 | 327 | class IPBlocklistPager extends ReverseChronologicalPager { |
| 327 | 328 | public $mForm, $mConds; |
| Index: trunk/phase3/includes/SpecialMostlinkedcategories.php |
| — | — | @@ -8,10 +8,6 @@ |
| 9 | 9 | * @copyright Copyright © 2005, Ævar Arnfjörð Bjarmason |
| 10 | 10 | * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License 2.0 or later |
| 11 | 11 | */ |
| 12 | | - |
| 13 | | -/** |
| 14 | | - * @addtogroup SpecialPage |
| 15 | | - */ |
| 16 | 12 | class MostlinkedCategoriesPage extends QueryPage { |
| 17 | 13 | |
| 18 | 14 | function getName() { return 'Mostlinkedcategories'; } |
| Index: trunk/phase3/includes/SpecialRevisiondelete.php |
| — | — | @@ -35,6 +35,10 @@ |
| 36 | 36 | } |
| 37 | 37 | } |
| 38 | 38 | |
| | 39 | +/** |
| | 40 | + * Implements the GUI for Revision Deletion. |
| | 41 | + * @addtogroup SpecialPage |
| | 42 | + */ |
| 39 | 43 | class RevisionDeleteForm { |
| 40 | 44 | /** |
| 41 | 45 | * @param Title $page |
| — | — | @@ -170,7 +174,10 @@ |
| 171 | 175 | } |
| 172 | 176 | } |
| 173 | 177 | |
| 174 | | - |
| | 178 | +/** |
| | 179 | + * Implements the actions for Revision Deletion. |
| | 180 | + * @addtogroup SpecialPage |
| | 181 | + */ |
| 175 | 182 | class RevisionDeleter { |
| 176 | 183 | function __construct( $db ) { |
| 177 | 184 | $this->db = $db; |
| Index: trunk/phase3/includes/memcached-client.php |
| — | — | @@ -91,7 +91,7 @@ |
| 92 | 92 | * memcached client class implemented using (p)fsockopen() |
| 93 | 93 | * |
| 94 | 94 | * @author Ryan T. Dean <rtdean@cytherianage.net> |
| 95 | | - * @package memcached-client |
| | 95 | + * @addtogroup cache |
| 96 | 96 | */ |
| 97 | 97 | class memcached |
| 98 | 98 | { |
| Index: trunk/phase3/includes/SpecialAllpages.php |
| — | — | @@ -36,6 +36,10 @@ |
| 37 | 37 | } |
| 38 | 38 | } |
| 39 | 39 | |
| | 40 | +/** |
| | 41 | + * Implements Special:Allpages |
| | 42 | + * @addtogroup SpecialPage |
| | 43 | + */ |
| 40 | 44 | class SpecialAllpages { |
| 41 | 45 | var $maxPerPage=960; |
| 42 | 46 | var $topLevelMax=50; |
| Index: trunk/phase3/includes/FileStore.php |
| — | — | @@ -371,6 +371,9 @@ |
| 372 | 372 | } |
| 373 | 373 | } |
| 374 | 374 | |
| | 375 | +/** |
| | 376 | + * @addtogroup Exception |
| | 377 | + */ |
| 375 | 378 | class FSException extends MWException { } |
| 376 | 379 | |
| 377 | 380 | ?> |
| Index: trunk/phase3/includes/QueryPage.php |
| — | — | @@ -52,7 +52,7 @@ |
| 53 | 53 | * This is a class for doing query pages; since they're almost all the same, |
| 54 | 54 | * we factor out some of the functionality into a superclass, and let |
| 55 | 55 | * subclasses derive from it. |
| 56 | | - * |
| | 56 | + * @addtogroup SpecialPage |
| 57 | 57 | */ |
| 58 | 58 | class QueryPage { |
| 59 | 59 | /** |
| — | — | @@ -525,4 +525,4 @@ |
| 526 | 526 | } |
| 527 | 527 | } |
| 528 | 528 | |
| 529 | | -?> |
| \ No newline at end of file |
| | 529 | +?> |
| Index: trunk/phase3/includes/Database.php |
| — | — | @@ -17,6 +17,7 @@ |
| 18 | 18 | |
| 19 | 19 | /** |
| 20 | 20 | * Utility class. |
| | 21 | + * @addtogroup Database |
| 21 | 22 | */ |
| 22 | 23 | class DBObject { |
| 23 | 24 | public $mData; |
| — | — | @@ -36,6 +37,7 @@ |
| 37 | 38 | |
| 38 | 39 | /** |
| 39 | 40 | * Utility class. |
| | 41 | + * @addtogroup Database |
| 40 | 42 | */ |
| 41 | 43 | class MySQLField { |
| 42 | 44 | private $name, $tablename, $default, $max_length, $nullable, |
| — | — | @@ -92,6 +94,7 @@ |
| 93 | 95 | |
| 94 | 96 | /** |
| 95 | 97 | * Database error base class |
| | 98 | + * @addtogroup Database |
| 96 | 99 | */ |
| 97 | 100 | class DBError extends MWException { |
| 98 | 101 | public $db; |
| — | — | @@ -107,6 +110,9 @@ |
| 108 | 111 | } |
| 109 | 112 | } |
| 110 | 113 | |
| | 114 | +/** |
| | 115 | + * @addtogroup Database |
| | 116 | + */ |
| 111 | 117 | class DBConnectionError extends DBError { |
| 112 | 118 | public $error; |
| 113 | 119 | |
| — | — | @@ -224,6 +230,9 @@ |
| 225 | 231 | } |
| 226 | 232 | } |
| 227 | 233 | |
| | 234 | +/** |
| | 235 | + * @addtogroup Database |
| | 236 | + */ |
| 228 | 237 | class DBQueryError extends DBError { |
| 229 | 238 | public $error, $errno, $sql, $fname; |
| 230 | 239 | |
| — | — | @@ -277,12 +286,16 @@ |
| 278 | 287 | } |
| 279 | 288 | } |
| 280 | 289 | |
| | 290 | +/** |
| | 291 | + * @addtogroup Database |
| | 292 | + */ |
| 281 | 293 | class DBUnexpectedError extends DBError {} |
| 282 | 294 | |
| 283 | 295 | /******************************************************************************/ |
| 284 | 296 | |
| 285 | 297 | /** |
| 286 | 298 | * Database abstraction object |
| | 299 | + * @addtogroup Database |
| 287 | 300 | */ |
| 288 | 301 | class Database { |
| 289 | 302 | |
| — | — | @@ -2181,6 +2194,7 @@ |
| 2182 | 2195 | * Database abstraction object for mySQL |
| 2183 | 2196 | * Inherit all methods and properties of Database::Database() |
| 2184 | 2197 | * |
| | 2198 | + * @addtogroup Database |
| 2185 | 2199 | * @see Database |
| 2186 | 2200 | */ |
| 2187 | 2201 | class DatabaseMysql extends Database { |
| — | — | @@ -2190,7 +2204,7 @@ |
| 2191 | 2205 | |
| 2192 | 2206 | /** |
| 2193 | 2207 | * Result wrapper for grabbing data queried by someone else |
| 2194 | | - * |
| | 2208 | + * @addtogroup Database |
| 2195 | 2209 | */ |
| 2196 | 2210 | class ResultWrapper { |
| 2197 | 2211 | var $db, $result; |
| Index: trunk/phase3/includes/ProfilerSimpleUDP.php |
| — | — | @@ -6,6 +6,7 @@ |
| 7 | 7 | /** |
| 8 | 8 | * ProfilerSimpleUDP class, that sends out messages for 'udpprofile' daemon |
| 9 | 9 | * (the one from mediawiki/trunk/udpprofile SVN ) |
| | 10 | + * @addtogroup Profiler |
| 10 | 11 | */ |
| 11 | 12 | class ProfilerSimpleUDP extends ProfilerSimple { |
| 12 | 13 | function getFunctionReport() { |
| Index: trunk/phase3/includes/SearchUpdate.php |
| — | — | @@ -1,11 +1,8 @@ |
| 2 | 2 | <?php |
| 3 | 3 | /** |
| 4 | 4 | * See deferred.txt |
| | 5 | + * @addtogroup Search |
| 5 | 6 | */ |
| 6 | | - |
| 7 | | -/** |
| 8 | | - * |
| 9 | | - */ |
| 10 | 7 | class SearchUpdate { |
| 11 | 8 | |
| 12 | 9 | /* private */ var $mId = 0, $mNamespace, $mTitle, $mText; |
| — | — | @@ -109,6 +106,7 @@ |
| 110 | 107 | |
| 111 | 108 | /** |
| 112 | 109 | * Placeholder class |
| | 110 | + * @addtogroup Search |
| 113 | 111 | */ |
| 114 | 112 | class SearchUpdateMyISAM extends SearchUpdate { |
| 115 | 113 | # Inherits everything |
| Index: trunk/phase3/includes/SpecialUpload.php |
| — | — | @@ -15,7 +15,7 @@ |
| 16 | 16 | } |
| 17 | 17 | |
| 18 | 18 | /** |
| 19 | | - * |
| | 19 | + * implements Special:Upload |
| 20 | 20 | * @addtogroup SpecialPage |
| 21 | 21 | */ |
| 22 | 22 | class UploadForm { |
| Index: trunk/phase3/includes/SpecialPrefixindex.php |
| — | — | @@ -41,6 +41,10 @@ |
| 42 | 42 | } |
| 43 | 43 | } |
| 44 | 44 | |
| | 45 | +/** |
| | 46 | + * implements Special:Prefixindex |
| | 47 | + * @addtogroup SpecialPage |
| | 48 | + */ |
| 45 | 49 | class SpecialPrefixindex extends SpecialAllpages { |
| 46 | 50 | var $maxPerPage=960; |
| 47 | 51 | var $topLevelMax=50; |
| Index: trunk/phase3/includes/AjaxDispatcher.php |
| — | — | @@ -11,6 +11,7 @@ |
| 12 | 12 | |
| 13 | 13 | /** |
| 14 | 14 | * @todo Document - e.g. Provide top-level description of this class. |
| | 15 | + * @addtogroup Ajax |
| 15 | 16 | */ |
| 16 | 17 | class AjaxDispatcher { |
| 17 | 18 | var $mode; |
| Index: trunk/phase3/includes/SearchOracle.php |
| — | — | @@ -21,7 +21,6 @@ |
| 22 | 22 | * Search engine hook base class for Oracle (ConText). |
| 23 | 23 | * @addtogroup Search |
| 24 | 24 | */ |
| 25 | | - |
| 26 | 25 | class SearchOracle extends SearchEngine { |
| 27 | 26 | function __construct($db) { |
| 28 | 27 | $this->db = $db; |
| — | — | @@ -208,6 +207,9 @@ |
| 209 | 208 | } |
| 210 | 209 | } |
| 211 | 210 | |
| | 211 | +/** |
| | 212 | + * @addtogroup Search |
| | 213 | + */ |
| 212 | 214 | class OracleSearchResultSet extends SearchResultSet { |
| 213 | 215 | function __construct($resultSet, $terms) { |
| 214 | 216 | $this->mResultSet = $resultSet; |
| Index: trunk/phase3/includes/Parser.php |
| — | — | @@ -86,6 +86,7 @@ |
| 87 | 87 | * * only within ParserOptions |
| 88 | 88 | * </pre> |
| 89 | 89 | * |
| | 90 | + * @addtogroup Parser |
| 90 | 91 | */ |
| 91 | 92 | class Parser |
| 92 | 93 | { |
| — | — | @@ -4721,6 +4722,7 @@ |
| 4722 | 4723 | |
| 4723 | 4724 | /** |
| 4724 | 4725 | * @todo document, briefly. |
| | 4726 | + * @addtogroup Parser |
| 4725 | 4727 | */ |
| 4726 | 4728 | class OnlyIncludeReplacer { |
| 4727 | 4729 | var $output = ''; |
| — | — | @@ -4736,6 +4738,7 @@ |
| 4737 | 4739 | |
| 4738 | 4740 | /** |
| 4739 | 4741 | * @todo document, briefly. |
| | 4742 | + * @addtogroup Parser |
| 4740 | 4743 | */ |
| 4741 | 4744 | class StripState { |
| 4742 | 4745 | var $general, $nowiki; |
| Index: trunk/phase3/includes/Exception.php |
| — | — | @@ -1,5 +1,8 @@ |
| 2 | 2 | <?php |
| 3 | 3 | |
| | 4 | +/** |
| | 5 | + * @addtogroup Exception |
| | 6 | + */ |
| 4 | 7 | class MWException extends Exception |
| 5 | 8 | { |
| 6 | 9 | function useOutputPage() { |
| — | — | @@ -125,6 +128,7 @@ |
| 126 | 129 | /** |
| 127 | 130 | * Exception class which takes an HTML error message, and does not |
| 128 | 131 | * produce a backtrace. Replacement for OutputPage::fatalError(). |
| | 132 | + * @addtogroup Exception |
| 129 | 133 | */ |
| 130 | 134 | class FatalError extends MWException { |
| 131 | 135 | function getHTML() { |
| — | — | @@ -136,6 +140,9 @@ |
| 137 | 141 | } |
| 138 | 142 | } |
| 139 | 143 | |
| | 144 | +/** |
| | 145 | + * @addtogroup Exception |
| | 146 | + */ |
| 140 | 147 | class ErrorPageError extends MWException { |
| 141 | 148 | public $title, $msg; |
| 142 | 149 | |
| Index: trunk/phase3/includes/SpecialProtectedpages.php |
| — | — | @@ -186,6 +186,7 @@ |
| 187 | 187 | |
| 188 | 188 | /** |
| 189 | 189 | * @todo document |
| | 190 | + * @addtogroup Pager |
| 190 | 191 | */ |
| 191 | 192 | class ProtectedPagesPager extends ReverseChronologicalPager { |
| 192 | 193 | public $mForm, $mConds; |
| Index: trunk/phase3/includes/SpecialRandompage.php |
| — | — | @@ -31,6 +31,11 @@ |
| 32 | 32 | } |
| 33 | 33 | |
| 34 | 34 | |
| | 35 | +/** |
| | 36 | + * Special page to direct the user to a random page |
| | 37 | + * |
| | 38 | + * @addtogroup SpecialPage |
| | 39 | + */ |
| 35 | 40 | class RandomPage { |
| 36 | 41 | private $namespace = NS_MAIN; // namespace to select pages from |
| 37 | 42 | private $redirect = false; // select redirects instead of normal pages? |
| Index: trunk/phase3/includes/SearchMySQL4.php |
| — | — | @@ -21,10 +21,6 @@ |
| 22 | 22 | * Search engine hook for MySQL 4+ |
| 23 | 23 | * @addtogroup Search |
| 24 | 24 | */ |
| 25 | | - |
| 26 | | -/** |
| 27 | | - * @addtogroup Search |
| 28 | | - */ |
| 29 | 25 | class SearchMySQL4 extends SearchMySQL { |
| 30 | 26 | var $strictMatching = true; |
| 31 | 27 | |
| Index: trunk/phase3/includes/Export.php |
| — | — | @@ -281,6 +281,9 @@ |
| 282 | 282 | } |
| 283 | 283 | } |
| 284 | 284 | |
| | 285 | +/** |
| | 286 | + * @addtogroup Dump |
| | 287 | + */ |
| 285 | 288 | class XmlDumpWriter { |
| 286 | 289 | |
| 287 | 290 | /** |
| — | — | @@ -463,6 +466,7 @@ |
| 464 | 467 | |
| 465 | 468 | /** |
| 466 | 469 | * Base class for output stream; prints to stdout or buffer or whereever. |
| | 470 | + * @addtogroup Dump |
| 467 | 471 | */ |
| 468 | 472 | class DumpOutput { |
| 469 | 473 | function writeOpenStream( $string ) { |
| — | — | @@ -496,6 +500,7 @@ |
| 497 | 501 | |
| 498 | 502 | /** |
| 499 | 503 | * Stream outputter to send data to a file. |
| | 504 | + * @addtogroup Dump |
| 500 | 505 | */ |
| 501 | 506 | class DumpFileOutput extends DumpOutput { |
| 502 | 507 | var $handle; |
| — | — | @@ -513,6 +518,7 @@ |
| 514 | 519 | * Stream outputter to send data to a file via some filter program. |
| 515 | 520 | * Even if compression is available in a library, using a separate |
| 516 | 521 | * program can allow us to make use of a multi-processor system. |
| | 522 | + * @addtogroup Dump |
| 517 | 523 | */ |
| 518 | 524 | class DumpPipeOutput extends DumpFileOutput { |
| 519 | 525 | function DumpPipeOutput( $command, $file = null ) { |
| — | — | @@ -525,6 +531,7 @@ |
| 526 | 532 | |
| 527 | 533 | /** |
| 528 | 534 | * Sends dump output via the gzip compressor. |
| | 535 | + * @addtogroup Dump |
| 529 | 536 | */ |
| 530 | 537 | class DumpGZipOutput extends DumpPipeOutput { |
| 531 | 538 | function DumpGZipOutput( $file ) { |
| — | — | @@ -534,6 +541,7 @@ |
| 535 | 542 | |
| 536 | 543 | /** |
| 537 | 544 | * Sends dump output via the bgzip2 compressor. |
| | 545 | + * @addtogroup Dump |
| 538 | 546 | */ |
| 539 | 547 | class DumpBZip2Output extends DumpPipeOutput { |
| 540 | 548 | function DumpBZip2Output( $file ) { |
| — | — | @@ -543,6 +551,7 @@ |
| 544 | 552 | |
| 545 | 553 | /** |
| 546 | 554 | * Sends dump output via the p7zip compressor. |
| | 555 | + * @addtogroup Dump |
| 547 | 556 | */ |
| 548 | 557 | class Dump7ZipOutput extends DumpPipeOutput { |
| 549 | 558 | function Dump7ZipOutput( $file ) { |
| — | — | @@ -560,6 +569,7 @@ |
| 561 | 570 | * Dump output filter class. |
| 562 | 571 | * This just does output filtering and streaming; XML formatting is done |
| 563 | 572 | * higher up, so be careful in what you do. |
| | 573 | + * @addtogroup Dump |
| 564 | 574 | */ |
| 565 | 575 | class DumpFilter { |
| 566 | 576 | function DumpFilter( &$sink ) { |
| — | — | @@ -605,6 +615,7 @@ |
| 606 | 616 | |
| 607 | 617 | /** |
| 608 | 618 | * Simple dump output filter to exclude all talk pages. |
| | 619 | + * @addtogroup Dump |
| 609 | 620 | */ |
| 610 | 621 | class DumpNotalkFilter extends DumpFilter { |
| 611 | 622 | function pass( $page ) { |
| — | — | @@ -614,6 +625,7 @@ |
| 615 | 626 | |
| 616 | 627 | /** |
| 617 | 628 | * Dump output filter to include or exclude pages in a given set of namespaces. |
| | 629 | + * @addtogroup Dump |
| 618 | 630 | */ |
| 619 | 631 | class DumpNamespaceFilter extends DumpFilter { |
| 620 | 632 | var $invert = false; |
| — | — | @@ -668,6 +680,7 @@ |
| 669 | 681 | |
| 670 | 682 | /** |
| 671 | 683 | * Dump output filter to include only the last revision in each page sequence. |
| | 684 | + * @addtogroup Dump |
| 672 | 685 | */ |
| 673 | 686 | class DumpLatestFilter extends DumpFilter { |
| 674 | 687 | var $page, $pageString, $rev, $revString; |
| — | — | @@ -699,6 +712,7 @@ |
| 700 | 713 | |
| 701 | 714 | /** |
| 702 | 715 | * Base class for output stream; prints to stdout or buffer or whereever. |
| | 716 | + * @addtogroup Dump |
| 703 | 717 | */ |
| 704 | 718 | class DumpMultiWriter { |
| 705 | 719 | function DumpMultiWriter( $sinks ) { |
| Index: trunk/phase3/includes/SpecialUploadMogile.php |
| — | — | @@ -18,6 +18,9 @@ |
| 19 | 19 | $form->execute(); |
| 20 | 20 | } |
| 21 | 21 | |
| | 22 | +/** |
| | 23 | + * @addtogroup SpecialPage |
| | 24 | + */ |
| 22 | 25 | class UploadFormMogile extends UploadForm { |
| 23 | 26 | /** |
| 24 | 27 | * Move the uploaded file from its temporary location to the final |
| Index: trunk/phase3/includes/SearchPostgres.php |
| — | — | @@ -21,7 +21,6 @@ |
| 22 | 22 | * Search engine hook base class for Postgres |
| 23 | 23 | * @addtogroup Search |
| 24 | 24 | */ |
| 25 | | - |
| 26 | 25 | class SearchPostgres extends SearchEngine { |
| 27 | 26 | |
| 28 | 27 | function SearchPostgres( $db ) { |
| — | — | @@ -182,7 +181,9 @@ |
| 183 | 182 | |
| 184 | 183 | } ## end of the SearchPostgres class |
| 185 | 184 | |
| 186 | | - |
| | 185 | +/** |
| | 186 | + * @addtogroup Search |
| | 187 | + */ |
| 187 | 188 | class PostgresSearchResult extends SearchResult { |
| 188 | 189 | function PostgresSearchResult( $row ) { |
| 189 | 190 | $this->mTitle = Title::makeTitle( $row->page_namespace, $row->page_title ); |
| — | — | @@ -193,6 +194,9 @@ |
| 194 | 195 | } |
| 195 | 196 | } |
| 196 | 197 | |
| | 198 | +/** |
| | 199 | + * @addtogroup Search |
| | 200 | + */ |
| 197 | 201 | class PostgresSearchResultSet extends SearchResultSet { |
| 198 | 202 | function PostgresSearchResultSet( $resultSet, $terms ) { |
| 199 | 203 | $this->mResultSet = $resultSet; |
| Index: trunk/phase3/includes/CoreParserFunctions.php |
| — | — | @@ -2,8 +2,8 @@ |
| 3 | 3 | |
| 4 | 4 | /** |
| 5 | 5 | * Various core parser functions, registered in Parser::firstCallInit() |
| | 6 | + * @addtogroup Parser |
| 6 | 7 | */ |
| 7 | | - |
| 8 | 8 | class CoreParserFunctions { |
| 9 | 9 | static function intFunction( $parser, $part1 = '' /*, ... */ ) { |
| 10 | 10 | if ( strval( $part1 ) !== '' ) { |
| Index: trunk/phase3/includes/PageHistory.php |
| — | — | @@ -14,7 +14,6 @@ |
| 15 | 15 | * history. |
| 16 | 16 | * |
| 17 | 17 | */ |
| 18 | | - |
| 19 | 18 | class PageHistory { |
| 20 | 19 | const DIR_PREV = 0; |
| 21 | 20 | const DIR_NEXT = 1; |
| — | — | @@ -523,6 +522,9 @@ |
| 524 | 523 | } |
| 525 | 524 | |
| 526 | 525 | |
| | 526 | +/** |
| | 527 | + * @addtogroup Pager |
| | 528 | + */ |
| 527 | 529 | class PageHistoryPager extends ReverseChronologicalPager { |
| 528 | 530 | public $mLastRow = false, $mPageHistory; |
| 529 | 531 | |
| Index: trunk/phase3/includes/PageQueryPage.php |
| — | — | @@ -4,6 +4,7 @@ |
| 5 | 5 | * Variant of QueryPage which formats the result as a simple link to the page |
| 6 | 6 | * |
| 7 | 7 | * @package MediaWiki |
| | 8 | + * @addtogroup SpecialPage |
| 8 | 9 | */ |
| 9 | 10 | class PageQueryPage extends QueryPage { |
| 10 | 11 | |
| — | — | @@ -22,4 +23,4 @@ |
| 23 | 24 | } |
| 24 | 25 | } |
| 25 | 26 | |
| 26 | | -?> |
| \ No newline at end of file |
| | 27 | +?> |
| Index: trunk/phase3/includes/SpecialWantedpages.php |
| — | — | @@ -5,7 +5,7 @@ |
| 6 | 6 | */ |
| 7 | 7 | |
| 8 | 8 | /** |
| 9 | | - * |
| | 9 | + * implements Special:Wantedpages |
| 10 | 10 | * @addtogroup SpecialPage |
| 11 | 11 | */ |
| 12 | 12 | class WantedPagesPage extends QueryPage { |
| Index: trunk/phase3/includes/SpecialUserlogin.php |
| — | — | @@ -19,10 +19,9 @@ |
| 20 | 20 | } |
| 21 | 21 | |
| 22 | 22 | /** |
| 23 | | - * @todo document, briefly. |
| | 23 | + * implements Special:Login |
| 24 | 24 | * @addtogroup SpecialPage |
| 25 | 25 | */ |
| 26 | | - |
| 27 | 26 | class LoginForm { |
| 28 | 27 | |
| 29 | 28 | const SUCCESS = 0; |
| Index: trunk/phase3/includes/AjaxFunctions.php |
| — | — | @@ -1,5 +1,10 @@ |
| 2 | 2 | <?php |
| 3 | 3 | |
| | 4 | +/** |
| | 5 | + * @package MediaWiki |
| | 6 | + * @addtogroup Ajax |
| | 7 | + */ |
| | 8 | + |
| 4 | 9 | if( !defined( 'MEDIAWIKI' ) ) |
| 5 | 10 | die( 1 ); |
| 6 | 11 | |
| Index: trunk/phase3/includes/SpecialPage.php |
| — | — | @@ -26,7 +26,8 @@ |
| 27 | 27 | |
| 28 | 28 | /** |
| 29 | 29 | * Parent special page class, also static functions for handling the special |
| 30 | | - * page list |
| | 30 | + * page list. |
| | 31 | + * @addtogroup SpecialPage |
| 31 | 32 | */ |
| 32 | 33 | class SpecialPage |
| 33 | 34 | { |
| — | — | @@ -692,6 +693,7 @@ |
| 693 | 694 | |
| 694 | 695 | /** |
| 695 | 696 | * Shortcut to construct a special page which is unlisted by default |
| | 697 | + * @addtogroup SpecialPage |
| 696 | 698 | */ |
| 697 | 699 | class UnlistedSpecialPage extends SpecialPage |
| 698 | 700 | { |
| — | — | @@ -702,6 +704,7 @@ |
| 703 | 705 | |
| 704 | 706 | /** |
| 705 | 707 | * Shortcut to construct an includable special page |
| | 708 | + * @addtogroup SpecialPage |
| 706 | 709 | */ |
| 707 | 710 | class IncludableSpecialPage extends SpecialPage |
| 708 | 711 | { |
| — | — | @@ -710,6 +713,9 @@ |
| 711 | 714 | } |
| 712 | 715 | } |
| 713 | 716 | |
| | 717 | +/** |
| | 718 | + * @addtogroup SpecialPage |
| | 719 | + */ |
| 714 | 720 | class SpecialRedirectToSpecial extends UnlistedSpecialPage { |
| 715 | 721 | var $redirName, $redirSubpage; |
| 716 | 722 | |
| — | — | @@ -729,6 +735,9 @@ |
| 730 | 736 | } |
| 731 | 737 | } |
| 732 | 738 | |
| | 739 | +/** |
| | 740 | + * @addtogroup SpecialPage |
| | 741 | + */ |
| 733 | 742 | class SpecialMypage extends UnlistedSpecialPage { |
| 734 | 743 | function __construct() { |
| 735 | 744 | parent::__construct( 'Mypage' ); |
| — | — | @@ -745,6 +754,9 @@ |
| 746 | 755 | } |
| 747 | 756 | } |
| 748 | 757 | |
| | 758 | +/** |
| | 759 | + * @addtogroup SpecialPage |
| | 760 | + */ |
| 749 | 761 | class SpecialMytalk extends UnlistedSpecialPage { |
| 750 | 762 | function __construct() { |
| 751 | 763 | parent::__construct( 'Mytalk' ); |
| — | — | @@ -761,6 +773,9 @@ |
| 762 | 774 | } |
| 763 | 775 | } |
| 764 | 776 | |
| | 777 | +/** |
| | 778 | + * @addtogroup SpecialPage |
| | 779 | + */ |
| 765 | 780 | class SpecialMycontributions extends UnlistedSpecialPage { |
| 766 | 781 | function __construct() { |
| 767 | 782 | parent::__construct( 'Mycontributions' ); |
| Index: trunk/phase3/includes/ParserCache.php |
| — | — | @@ -2,9 +2,6 @@ |
| 3 | 3 | /** |
| 4 | 4 | * |
| 5 | 5 | * @addtogroup Cache |
| 6 | | - */ |
| 7 | | - |
| 8 | | -/** |
| 9 | 6 | * @todo document |
| 10 | 7 | */ |
| 11 | 8 | class ParserCache { |
| Index: trunk/phase3/includes/SpecialUnusedimages.php |
| — | — | @@ -5,6 +5,7 @@ |
| 6 | 6 | */ |
| 7 | 7 | |
| 8 | 8 | /** |
| | 9 | + * implements Special:Unusedimages |
| 9 | 10 | * @addtogroup SpecialPage |
| 10 | 11 | */ |
| 11 | 12 | class UnusedimagesPage extends ImageQueryPage { |
| Index: trunk/phase3/includes/SpecialWithoutinterwiki.php |
| — | — | @@ -4,6 +4,7 @@ |
| 5 | 5 | * Special page lists pages without language links |
| 6 | 6 | * |
| 7 | 7 | * @package MediaWiki |
| | 8 | + * @addtogroup SpecialPage |
| 8 | 9 | * @author Rob Church <robchur@gmail.com> |
| 9 | 10 | */ |
| 10 | 11 | class WithoutInterwikiPage extends PageQueryPage { |
| — | — | @@ -52,4 +53,4 @@ |
| 53 | 54 | $wip->doQuery( $offset, $limit ); |
| 54 | 55 | } |
| 55 | 56 | |
| 56 | | -?> |
| \ No newline at end of file |
| | 57 | +?> |
| Index: trunk/phase3/includes/SearchMySQL.php |
| — | — | @@ -22,7 +22,6 @@ |
| 23 | 23 | * Specific bits for MySQL 3 and 4 variants are in child classes. |
| 24 | 24 | * @addtogroup Search |
| 25 | 25 | */ |
| 26 | | - |
| 27 | 26 | class SearchMySQL extends SearchEngine { |
| 28 | 27 | /** |
| 29 | 28 | * Perform a full text search query and return a result set. |
| — | — | @@ -176,6 +175,9 @@ |
| 177 | 176 | } |
| 178 | 177 | } |
| 179 | 178 | |
| | 179 | +/** |
| | 180 | + * @addtogroup Search |
| | 181 | + */ |
| 180 | 182 | class MySQLSearchResultSet extends SearchResultSet { |
| 181 | 183 | function MySQLSearchResultSet( $resultSet, $terms ) { |
| 182 | 184 | $this->mResultSet = $resultSet; |
| Index: trunk/phase3/includes/SpecialFewestrevisions.php |
| — | — | @@ -1,14 +1,12 @@ |
| 2 | 2 | <?php |
| 3 | 3 | |
| 4 | 4 | /** |
| 5 | | - * |
| 6 | 5 | * Special page for listing the articles with the fewest revisions. |
| 7 | 6 | * |
| 8 | 7 | * @package MediaWiki |
| 9 | | - * @subpackage Special pages |
| | 8 | + * @addtogroup SpecialPage |
| 10 | 9 | * @author Martin Drashkov |
| 11 | 10 | */ |
| 12 | | - |
| 13 | 11 | class FewestrevisionsPage extends QueryPage { |
| 14 | 12 | |
| 15 | 13 | function getName() { |
| — | — | @@ -64,4 +62,4 @@ |
| 65 | 63 | $frp->doQuery( $offset, $limit ); |
| 66 | 64 | } |
| 67 | 65 | |
| 68 | | -?> |
| \ No newline at end of file |
| | 66 | +?> |
| Index: trunk/phase3/includes/SpecialAncientpages.php |
| — | — | @@ -5,7 +5,7 @@ |
| 6 | 6 | */ |
| 7 | 7 | |
| 8 | 8 | /** |
| 9 | | - * @todo document, briefly. |
| | 9 | + * Implements Special:Ancientpages |
| 10 | 10 | * @addtogroup SpecialPage |
| 11 | 11 | */ |
| 12 | 12 | class AncientPagesPage extends QueryPage { |
| Index: trunk/phase3/includes/CacheDependency.php |
| — | — | @@ -4,6 +4,7 @@ |
| 5 | 5 | * This class stores an arbitrary value along with its dependencies. |
| 6 | 6 | * Users should typically only use DependencyWrapper::getFromCache(), rather |
| 7 | 7 | * than instantiating one of these objects directly. |
| | 8 | + * @addtogroup Cache |
| 8 | 9 | */ |
| 9 | 10 | class DependencyWrapper { |
| 10 | 11 | var $value; |
| — | — | @@ -95,6 +96,9 @@ |
| 96 | 97 | } |
| 97 | 98 | } |
| 98 | 99 | |
| | 100 | +/** |
| | 101 | + * @addtogroup Cache |
| | 102 | + */ |
| 99 | 103 | abstract class CacheDependency { |
| 100 | 104 | /** |
| 101 | 105 | * Returns true if the dependency is expired, false otherwise |
| — | — | @@ -107,6 +111,9 @@ |
| 108 | 112 | function loadDependencyValues() {} |
| 109 | 113 | } |
| 110 | 114 | |
| | 115 | +/** |
| | 116 | + * @addtogroup Cache |
| | 117 | + */ |
| 111 | 118 | class FileDependency extends CacheDependency { |
| 112 | 119 | var $filename, $timestamp; |
| 113 | 120 | |
| — | — | @@ -163,6 +170,9 @@ |
| 164 | 171 | } |
| 165 | 172 | } |
| 166 | 173 | |
| | 174 | +/** |
| | 175 | + * @addtogroup Cache |
| | 176 | + */ |
| 167 | 177 | class TitleDependency extends CacheDependency { |
| 168 | 178 | var $titleObj; |
| 169 | 179 | var $ns, $dbk; |
| — | — | @@ -219,6 +229,9 @@ |
| 220 | 230 | } |
| 221 | 231 | } |
| 222 | 232 | |
| | 233 | +/** |
| | 234 | + * @addtogroup Cache |
| | 235 | + */ |
| 223 | 236 | class TitleListDependency extends CacheDependency { |
| 224 | 237 | var $linkBatch; |
| 225 | 238 | var $timestamps; |
| — | — | @@ -299,6 +312,9 @@ |
| 300 | 313 | } |
| 301 | 314 | } |
| 302 | 315 | |
| | 316 | +/** |
| | 317 | + * @addtogroup Cache |
| | 318 | + */ |
| 303 | 319 | class GlobalDependency extends CacheDependency { |
| 304 | 320 | var $name, $value; |
| 305 | 321 | |
| — | — | @@ -312,6 +328,9 @@ |
| 313 | 329 | } |
| 314 | 330 | } |
| 315 | 331 | |
| | 332 | +/** |
| | 333 | + * @addtogroup Cache |
| | 334 | + */ |
| 316 | 335 | class ConstantDependency extends CacheDependency { |
| 317 | 336 | var $name, $value; |
| 318 | 337 | |
| Index: trunk/phase3/includes/SpecialUnwatchedpages.php |
| — | — | @@ -1,17 +1,13 @@ |
| 2 | 2 | <?php |
| 3 | 3 | /** |
| 4 | | - * A special page that displays a list of pages that are not on anyones watchlist |
| | 4 | + * A special page that displays a list of pages that are not on anyones watchlist. |
| | 5 | + * Implements Special:Unwatchedpages |
| 5 | 6 | * |
| 6 | 7 | * @addtogroup SpecialPage |
| 7 | | - * |
| 8 | 8 | * @author Ævar Arnfjörð Bjarmason <avarab@gmail.com> |
| 9 | 9 | * @copyright Copyright © 2005, Ævar Arnfjörð Bjarmason |
| 10 | 10 | * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License 2.0 or later |
| 11 | 11 | */ |
| 12 | | - |
| 13 | | -/** |
| 14 | | - * @addtogroup SpecialPage |
| 15 | | - */ |
| 16 | 12 | class UnwatchedpagesPage extends QueryPage { |
| 17 | 13 | |
| 18 | 14 | function getName() { return 'Unwatchedpages'; } |
| Index: trunk/phase3/includes/ParserOptions.php |
| — | — | @@ -3,6 +3,7 @@ |
| 4 | 4 | /** |
| 5 | 5 | * Set options of the Parser |
| 6 | 6 | * @todo document |
| | 7 | + * @addtogroup Parser |
| 7 | 8 | */ |
| 8 | 9 | class ParserOptions |
| 9 | 10 | { |
| Index: trunk/phase3/includes/SpecialMostimages.php |
| — | — | @@ -8,6 +8,7 @@ |
| 9 | 9 | */ |
| 10 | 10 | |
| 11 | 11 | /** |
| | 12 | + * implements Special:Mostimages |
| 12 | 13 | * @addtogroup SpecialPage |
| 13 | 14 | */ |
| 14 | 15 | class MostimagesPage extends ImageQueryPage { |
| Index: trunk/phase3/includes/Profiler.php |
| — | — | @@ -40,6 +40,7 @@ |
| 41 | 41 | |
| 42 | 42 | /** |
| 43 | 43 | * @todo document |
| | 44 | + * @addtogroup Profiler |
| 44 | 45 | */ |
| 45 | 46 | class Profiler { |
| 46 | 47 | var $mStack = array (), $mWorkStack = array (), $mCollated = array (); |
| Index: trunk/phase3/includes/api/ApiQuery.php |
| — | — | @@ -1,6 +1,5 @@ |
| 2 | 2 | <?php |
| 3 | 3 | |
| 4 | | - |
| 5 | 4 | /* |
| 6 | 5 | * Created on Sep 7, 2006 |
| 7 | 6 | * |
| — | — | @@ -29,6 +28,9 @@ |
| 30 | 29 | require_once ('ApiBase.php'); |
| 31 | 30 | } |
| 32 | 31 | |
| | 32 | +/** |
| | 33 | + * @addtogroup API |
| | 34 | + */ |
| 33 | 35 | class ApiQuery extends ApiBase { |
| 34 | 36 | |
| 35 | 37 | private $mPropModuleNames, $mListModuleNames, $mMetaModuleNames; |
| Index: trunk/phase3/includes/api/ApiQuerySiteinfo.php |
| — | — | @@ -1,6 +1,5 @@ |
| 2 | 2 | <?php |
| 3 | 3 | |
| 4 | | - |
| 5 | 4 | /* |
| 6 | 5 | * Created on Sep 25, 2006 |
| 7 | 6 | * |
| — | — | @@ -29,6 +28,9 @@ |
| 30 | 29 | require_once ('ApiQueryBase.php'); |
| 31 | 30 | } |
| 32 | 31 | |
| | 32 | +/** |
| | 33 | + * @addtogroup API |
| | 34 | + */ |
| 33 | 35 | class ApiQuerySiteinfo extends ApiQueryBase { |
| 34 | 36 | |
| 35 | 37 | public function __construct($query, $moduleName) { |
| — | — | @@ -113,4 +115,4 @@ |
| 114 | 116 | return __CLASS__ . ': $Id$'; |
| 115 | 117 | } |
| 116 | 118 | } |
| 117 | | -?> |
| \ No newline at end of file |
| | 119 | +?> |
| Index: trunk/phase3/includes/api/ApiQueryRevisions.php |
| — | — | @@ -1,6 +1,5 @@ |
| 2 | 2 | <?php |
| 3 | 3 | |
| 4 | | - |
| 5 | 4 | /* |
| 6 | 5 | * Created on Sep 7, 2006 |
| 7 | 6 | * |
| — | — | @@ -29,6 +28,9 @@ |
| 30 | 29 | require_once ('ApiQueryBase.php'); |
| 31 | 30 | } |
| 32 | 31 | |
| | 32 | +/** |
| | 33 | + * @addtogroup API |
| | 34 | + */ |
| 33 | 35 | class ApiQueryRevisions extends ApiQueryBase { |
| 34 | 36 | |
| 35 | 37 | public function __construct($query, $moduleName) { |
| Index: trunk/phase3/includes/api/ApiLogin.php |
| — | — | @@ -1,6 +1,5 @@ |
| 2 | 2 | <?php |
| 3 | 3 | |
| 4 | | - |
| 5 | 4 | /* |
| 6 | 5 | * Created on Sep 19, 2006 |
| 7 | 6 | * |
| — | — | @@ -29,6 +28,9 @@ |
| 30 | 29 | require_once ('ApiBase.php'); |
| 31 | 30 | } |
| 32 | 31 | |
| | 32 | +/** |
| | 33 | + * @addtogroup API |
| | 34 | + */ |
| 33 | 35 | class ApiLogin extends ApiBase { |
| 34 | 36 | |
| 35 | 37 | public function __construct($main, $action) { |
| Index: trunk/phase3/includes/api/ApiFormatYaml_spyc.php |
| — | — | @@ -6,12 +6,11 @@ |
| 7 | 7 | * @see http://spyc.sourceforge.net/ |
| 8 | 8 | * @copyright Copyright 2005-2006 Chris Wanstrath |
| 9 | 9 | * @license http://www.opensource.org/licenses/mit-license.php MIT License |
| 10 | | - * @addtogroup Spyc |
| 11 | 10 | */ |
| 12 | 11 | |
| 13 | 12 | /** |
| 14 | 13 | * A node, used by Spyc for parsing YAML. |
| 15 | | - * @addtogroup Spyc |
| | 14 | + * @addtogroup API |
| 16 | 15 | */ |
| 17 | 16 | class YAMLNode { |
| 18 | 17 | /**#@+ |
| — | — | @@ -59,7 +58,7 @@ |
| 60 | 59 | * $parser = new Spyc; |
| 61 | 60 | * $array = $parser->load($file); |
| 62 | 61 | * </code> |
| 63 | | - * @addtogroup Spyc |
| | 62 | + * @addtogroup API |
| 64 | 63 | */ |
| 65 | 64 | class Spyc { |
| 66 | 65 | |
| Index: trunk/phase3/includes/api/ApiFormatXml.php |
| — | — | @@ -1,6 +1,5 @@ |
| 2 | 2 | <?php |
| 3 | 3 | |
| 4 | | - |
| 5 | 4 | /* |
| 6 | 5 | * Created on Sep 19, 2006 |
| 7 | 6 | * |
| — | — | @@ -29,6 +28,9 @@ |
| 30 | 29 | require_once ('ApiFormatBase.php'); |
| 31 | 30 | } |
| 32 | 31 | |
| | 32 | +/** |
| | 33 | + * @addtogroup API |
| | 34 | + */ |
| 33 | 35 | class ApiFormatXml extends ApiFormatBase { |
| 34 | 36 | |
| 35 | 37 | private $mRootElemName = 'api'; |
| — | — | @@ -142,4 +144,4 @@ |
| 143 | 145 | return __CLASS__ . ': $Id$'; |
| 144 | 146 | } |
| 145 | 147 | } |
| 146 | | -?> |
| \ No newline at end of file |
| | 148 | +?> |
| Index: trunk/phase3/includes/api/ApiBase.php |
| — | — | @@ -1,6 +1,5 @@ |
| 2 | 2 | <?php |
| 3 | 3 | |
| 4 | | - |
| 5 | 4 | /* |
| 6 | 5 | * Created on Sep 5, 2006 |
| 7 | 6 | * |
| — | — | @@ -26,6 +25,7 @@ |
| 27 | 26 | |
| 28 | 27 | /** |
| 29 | 28 | * @todo Document - e.g. Provide top-level description of this class. |
| | 29 | + * @addtogroup API |
| 30 | 30 | */ |
| 31 | 31 | abstract class ApiBase { |
| 32 | 32 | |
| — | — | @@ -533,4 +533,4 @@ |
| 534 | 534 | return __CLASS__ . ': $Id$'; |
| 535 | 535 | } |
| 536 | 536 | } |
| 537 | | -?> |
| \ No newline at end of file |
| | 537 | +?> |
| Index: trunk/phase3/includes/api/ApiFormatYaml.php |
| — | — | @@ -1,6 +1,5 @@ |
| 2 | 2 | <?php |
| 3 | 3 | |
| 4 | | - |
| 5 | 4 | /* |
| 6 | 5 | * Created on Sep 19, 2006 |
| 7 | 6 | * |
| — | — | @@ -29,6 +28,9 @@ |
| 30 | 29 | require_once ('ApiFormatBase.php'); |
| 31 | 30 | } |
| 32 | 31 | |
| | 32 | +/** |
| | 33 | + * @addtogroup API |
| | 34 | + */ |
| 33 | 35 | class ApiFormatYaml extends ApiFormatBase { |
| 34 | 36 | |
| 35 | 37 | public function __construct($main, $format) { |
| — | — | @@ -51,4 +53,4 @@ |
| 52 | 54 | return __CLASS__ . ': $Id$'; |
| 53 | 55 | } |
| 54 | 56 | } |
| 55 | | -?> |
| \ No newline at end of file |
| | 57 | +?> |
| Index: trunk/phase3/includes/api/ApiFormatJson_json.php |
| — | — | @@ -45,7 +45,7 @@ |
| 46 | 46 | * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH |
| 47 | 47 | * DAMAGE. |
| 48 | 48 | * |
| 49 | | -* @addtogroup Services_JSON |
| | 49 | +* @addtogroup API |
| 50 | 50 | * @author Michal Migurski <mike-json@teczno.com> |
| 51 | 51 | * @author Matt Knapp <mdknapp[at]gmail[dot]com> |
| 52 | 52 | * @author Brett Stimmerman <brettstimmerman[at]gmail[dot]com> |
| — | — | @@ -91,26 +91,28 @@ |
| 92 | 92 | define('SERVICES_JSON_SUPPRESS_ERRORS', 32); |
| 93 | 93 | |
| 94 | 94 | /** |
| 95 | | -* Converts to and from JSON format. |
| 96 | | -* |
| 97 | | -* Brief example of use: |
| 98 | | -* |
| 99 | | -* <code> |
| 100 | | -* // create a new instance of Services_JSON |
| 101 | | -* $json = new Services_JSON(); |
| 102 | | -* |
| 103 | | -* // convert a complexe value to JSON notation, and send it to the browser |
| 104 | | -* $value = array('foo', 'bar', array(1, 2, 'baz'), array(3, array(4))); |
| 105 | | -* $output = $json->encode($value); |
| 106 | | -* |
| 107 | | -* print($output); |
| 108 | | -* // prints: ["foo","bar",[1,2,"baz"],[3,[4]]] |
| 109 | | -* |
| 110 | | -* // accept incoming POST data, assumed to be in JSON notation |
| 111 | | -* $input = file_get_contents('php://input', 1000000); |
| 112 | | -* $value = $json->decode($input); |
| 113 | | -* </code> |
| 114 | | -*/ |
| | 95 | + * Converts to and from JSON format. |
| | 96 | + * |
| | 97 | + * Brief example of use: |
| | 98 | + * |
| | 99 | + * <code> |
| | 100 | + * // create a new instance of Services_JSON |
| | 101 | + * $json = new Services_JSON(); |
| | 102 | + * |
| | 103 | + * // convert a complexe value to JSON notation, and send it to the browser |
| | 104 | + * $value = array('foo', 'bar', array(1, 2, 'baz'), array(3, array(4))); |
| | 105 | + * $output = $json->encode($value); |
| | 106 | + * |
| | 107 | + * print($output); |
| | 108 | + * // prints: ["foo","bar",[1,2,"baz"],[3,[4]]] |
| | 109 | + * |
| | 110 | + * // accept incoming POST data, assumed to be in JSON notation |
| | 111 | + * $input = file_get_contents('php://input', 1000000); |
| | 112 | + * $value = $json->decode($input); |
| | 113 | + * </code> |
| | 114 | + * |
| | 115 | + * @addtogroup API |
| | 116 | + */ |
| 115 | 117 | class Services_JSON |
| 116 | 118 | { |
| 117 | 119 | /** |
| — | — | @@ -812,6 +814,9 @@ |
| 813 | 815 | |
| 814 | 816 | if (class_exists('PEAR_Error')) { |
| 815 | 817 | |
| | 818 | + /** |
| | 819 | + * @addtogroup API |
| | 820 | + */ |
| 816 | 821 | class Services_JSON_Error extends PEAR_Error |
| 817 | 822 | { |
| 818 | 823 | function Services_JSON_Error($message = 'unknown error', $code = null, |
| — | — | @@ -825,6 +830,7 @@ |
| 826 | 831 | |
| 827 | 832 | /** |
| 828 | 833 | * @todo Ultimately, this class shall be descended from PEAR_Error |
| | 834 | + * @addtogroup API |
| 829 | 835 | */ |
| 830 | 836 | class Services_JSON_Error |
| 831 | 837 | { |
| Index: trunk/phase3/includes/api/ApiQueryAllpages.php |
| — | — | @@ -1,6 +1,5 @@ |
| 2 | 2 | <?php |
| 3 | 3 | |
| 4 | | - |
| 5 | 4 | /* |
| 6 | 5 | * Created on Sep 25, 2006 |
| 7 | 6 | * |
| — | — | @@ -29,6 +28,9 @@ |
| 30 | 29 | require_once ('ApiQueryBase.php'); |
| 31 | 30 | } |
| 32 | 31 | |
| | 32 | +/** |
| | 33 | + * @addtogroup API |
| | 34 | + */ |
| 33 | 35 | class ApiQueryAllpages extends ApiQueryGeneratorBase { |
| 34 | 36 | |
| 35 | 37 | public function __construct($query, $moduleName) { |
| Index: trunk/phase3/includes/api/ApiResult.php |
| — | — | @@ -1,6 +1,5 @@ |
| 2 | 2 | <?php |
| 3 | 3 | |
| 4 | | - |
| 5 | 4 | /* |
| 6 | 5 | * Created on Sep 4, 2006 |
| 7 | 6 | * |
| — | — | @@ -29,6 +28,9 @@ |
| 30 | 29 | require_once ('ApiBase.php'); |
| 31 | 30 | } |
| 32 | 31 | |
| | 32 | +/** |
| | 33 | + * @addtogroup API |
| | 34 | + */ |
| 33 | 35 | class ApiResult extends ApiBase { |
| 34 | 36 | |
| 35 | 37 | private $mData, $mIsRawMode; |
| — | — | @@ -154,4 +156,4 @@ |
| 155 | 157 | return __CLASS__ . ': $Id$'; |
| 156 | 158 | } |
| 157 | 159 | } |
| 158 | | -?> |
| \ No newline at end of file |
| | 160 | +?> |
| Index: trunk/phase3/includes/api/ApiFormatWddx.php |
| — | — | @@ -1,6 +1,5 @@ |
| 2 | 2 | <?php |
| 3 | 3 | |
| 4 | | - |
| 5 | 4 | /* |
| 6 | 5 | * Created on Oct 22, 2006 |
| 7 | 6 | * |
| — | — | @@ -29,6 +28,9 @@ |
| 30 | 29 | require_once ('ApiFormatBase.php'); |
| 31 | 30 | } |
| 32 | 31 | |
| | 32 | +/** |
| | 33 | + * @addtogroup API |
| | 34 | + */ |
| 33 | 35 | class ApiFormatWddx extends ApiFormatBase { |
| 34 | 36 | |
| 35 | 37 | public function __construct($main, $format) { |
| — | — | @@ -86,4 +88,4 @@ |
| 87 | 89 | return __CLASS__ . ': $Id$'; |
| 88 | 90 | } |
| 89 | 91 | } |
| 90 | | -?> |
| \ No newline at end of file |
| | 92 | +?> |
| Index: trunk/phase3/includes/api/ApiQueryInfo.php |
| — | — | @@ -1,6 +1,5 @@ |
| 2 | 2 | <?php |
| 3 | 3 | |
| 4 | | - |
| 5 | 4 | /* |
| 6 | 5 | * Created on Sep 25, 2006 |
| 7 | 6 | * |
| — | — | @@ -29,6 +28,9 @@ |
| 30 | 29 | require_once ('ApiQueryBase.php'); |
| 31 | 30 | } |
| 32 | 31 | |
| | 32 | +/** |
| | 33 | + * @addtogroup API |
| | 34 | + */ |
| 33 | 35 | class ApiQueryInfo extends ApiQueryBase { |
| 34 | 36 | |
| 35 | 37 | public function __construct($query, $moduleName) { |
| Index: trunk/phase3/includes/api/ApiFormatJson.php |
| — | — | @@ -1,6 +1,5 @@ |
| 2 | 2 | <?php |
| 3 | 3 | |
| 4 | | - |
| 5 | 4 | /* |
| 6 | 5 | * Created on Sep 19, 2006 |
| 7 | 6 | * |
| — | — | @@ -29,6 +28,9 @@ |
| 30 | 29 | require_once ('ApiFormatBase.php'); |
| 31 | 30 | } |
| 32 | 31 | |
| | 32 | +/** |
| | 33 | + * @addtogroup API |
| | 34 | + */ |
| 33 | 35 | class ApiFormatJson extends ApiFormatBase { |
| 34 | 36 | |
| 35 | 37 | private $mIsRaw; |
| — | — | @@ -66,4 +68,4 @@ |
| 67 | 69 | return __CLASS__ . ': $Id$'; |
| 68 | 70 | } |
| 69 | 71 | } |
| 70 | | -?> |
| \ No newline at end of file |
| | 72 | +?> |
| Index: trunk/phase3/includes/api/ApiFormatBase.php |
| — | — | @@ -1,6 +1,5 @@ |
| 2 | 2 | <?php |
| 3 | 3 | |
| 4 | | - |
| 5 | 4 | /* |
| 6 | 5 | * Created on Sep 19, 2006 |
| 7 | 6 | * |
| — | — | @@ -29,6 +28,9 @@ |
| 30 | 29 | require_once ('ApiBase.php'); |
| 31 | 30 | } |
| 32 | 31 | |
| | 32 | +/** |
| | 33 | + * @addtogroup API |
| | 34 | + */ |
| 33 | 35 | abstract class ApiFormatBase extends ApiBase { |
| 34 | 36 | |
| 35 | 37 | private $mIsHtml, $mFormat; |
| — | — | @@ -176,6 +178,7 @@ |
| 177 | 179 | |
| 178 | 180 | /** |
| 179 | 181 | * This printer is used to wrap an instance of the Feed class |
| | 182 | + * @addtogroup API |
| 180 | 183 | */ |
| 181 | 184 | class ApiFormatFeedWrapper extends ApiFormatBase { |
| 182 | 185 | |
| Index: trunk/phase3/includes/api/ApiMain.php |
| — | — | @@ -1,6 +1,5 @@ |
| 2 | 2 | <?php |
| 3 | 3 | |
| 4 | | - |
| 5 | 4 | /* |
| 6 | 5 | * Created on Sep 4, 2006 |
| 7 | 6 | * |
| — | — | @@ -31,6 +30,7 @@ |
| 32 | 31 | |
| 33 | 32 | /** |
| 34 | 33 | * This is the main API class, used for both external and internal processing. |
| | 34 | + * @addtogroup API |
| 35 | 35 | */ |
| 36 | 36 | class ApiMain extends ApiBase { |
| 37 | 37 | |
| — | — | @@ -347,6 +347,7 @@ |
| 348 | 348 | |
| 349 | 349 | /** |
| 350 | 350 | * This exception will be thrown when dieUsage is called to stop module execution. |
| | 351 | + * @addtogroup API |
| 351 | 352 | */ |
| 352 | 353 | class UsageException extends Exception { |
| 353 | 354 | |
| Index: trunk/phase3/includes/api/ApiFeedWatchlist.php |
| — | — | @@ -1,6 +1,5 @@ |
| 2 | 2 | <?php |
| 3 | 3 | |
| 4 | | - |
| 5 | 4 | /* |
| 6 | 5 | * Created on Oct 13, 2006 |
| 7 | 6 | * |
| — | — | @@ -29,6 +28,9 @@ |
| 30 | 29 | require_once ("ApiBase.php"); |
| 31 | 30 | } |
| 32 | 31 | |
| | 32 | +/** |
| | 33 | + * @addtogroup API |
| | 34 | + */ |
| 33 | 35 | class ApiFeedWatchlist extends ApiBase { |
| 34 | 36 | |
| 35 | 37 | public function __construct($main, $action) { |
| Index: trunk/phase3/includes/api/ApiQueryUserContributions.php |
| — | — | @@ -1,6 +1,5 @@ |
| 2 | 2 | <?php |
| 3 | 3 | |
| 4 | | - |
| 5 | 4 | /* |
| 6 | 5 | * Created on Oct 16, 2006 |
| 7 | 6 | * |
| — | — | @@ -29,6 +28,9 @@ |
| 30 | 29 | require_once ('ApiQueryBase.php'); |
| 31 | 30 | } |
| 32 | 31 | |
| | 32 | +/** |
| | 33 | + * @addtogroup API |
| | 34 | + */ |
| 33 | 35 | class ApiQueryContributions extends ApiQueryBase { |
| 34 | 36 | |
| 35 | 37 | public function __construct($query, $moduleName) { |
| Index: trunk/phase3/includes/api/ApiQueryBacklinks.php |
| — | — | @@ -1,6 +1,5 @@ |
| 2 | 2 | <?php |
| 3 | 3 | |
| 4 | | - |
| 5 | 4 | /* |
| 6 | 5 | * Created on Oct 16, 2006 |
| 7 | 6 | * |
| — | — | @@ -29,6 +28,9 @@ |
| 30 | 29 | require_once ("ApiQueryBase.php"); |
| 31 | 30 | } |
| 32 | 31 | |
| | 32 | +/** |
| | 33 | + * @addtogroup API |
| | 34 | + */ |
| 33 | 35 | class ApiQueryBacklinks extends ApiQueryGeneratorBase { |
| 34 | 36 | |
| 35 | 37 | private $rootTitle, $contRedirs, $contLevel, $contTitle, $contID; |
| — | — | @@ -355,4 +357,4 @@ |
| 356 | 358 | return __CLASS__ . ': $Id$'; |
| 357 | 359 | } |
| 358 | 360 | } |
| 359 | | -?> |
| \ No newline at end of file |
| | 361 | +?> |
| Index: trunk/phase3/includes/api/ApiOpenSearch.php |
| — | — | @@ -1,6 +1,5 @@ |
| 2 | 2 | <?php |
| 3 | 3 | |
| 4 | | - |
| 5 | 4 | /* |
| 6 | 5 | * Created on Oct 13, 2006 |
| 7 | 6 | * |
| — | — | @@ -29,6 +28,9 @@ |
| 30 | 29 | require_once ("ApiBase.php"); |
| 31 | 30 | } |
| 32 | 31 | |
| | 32 | +/** |
| | 33 | + * @addtogroup API |
| | 34 | + */ |
| 33 | 35 | class ApiOpenSearch extends ApiBase { |
| 34 | 36 | |
| 35 | 37 | public function __construct($main, $action) { |
| — | — | @@ -106,4 +108,4 @@ |
| 107 | 109 | return __CLASS__ . ': $Id$'; |
| 108 | 110 | } |
| 109 | 111 | } |
| 110 | | -?> |
| \ No newline at end of file |
| | 112 | +?> |
| Index: trunk/phase3/includes/api/ApiQueryWatchlist.php |
| — | — | @@ -1,6 +1,5 @@ |
| 2 | 2 | <?php |
| 3 | 3 | |
| 4 | | - |
| 5 | 4 | /* |
| 6 | 5 | * Created on Sep 25, 2006 |
| 7 | 6 | * |
| — | — | @@ -29,6 +28,9 @@ |
| 30 | 29 | require_once ('ApiQueryBase.php'); |
| 31 | 30 | } |
| 32 | 31 | |
| | 32 | +/** |
| | 33 | + * @addtogroup API |
| | 34 | + */ |
| 33 | 35 | class ApiQueryWatchlist extends ApiQueryGeneratorBase { |
| 34 | 36 | |
| 35 | 37 | public function __construct($query, $moduleName) { |
| Index: trunk/phase3/includes/api/ApiHelp.php |
| — | — | @@ -1,6 +1,5 @@ |
| 2 | 2 | <?php |
| 3 | 3 | |
| 4 | | - |
| 5 | 4 | /* |
| 6 | 5 | * Created on Sep 6, 2006 |
| 7 | 6 | * |
| — | — | @@ -29,6 +28,9 @@ |
| 30 | 29 | require_once ('ApiBase.php'); |
| 31 | 30 | } |
| 32 | 31 | |
| | 32 | +/** |
| | 33 | + * @addtogroup API |
| | 34 | + */ |
| 33 | 35 | class ApiHelp extends ApiBase { |
| 34 | 36 | |
| 35 | 37 | public function __construct($main, $action) { |
| — | — | @@ -52,4 +54,4 @@ |
| 53 | 55 | return __CLASS__ . ': $Id$'; |
| 54 | 56 | } |
| 55 | 57 | } |
| 56 | | -?> |
| \ No newline at end of file |
| | 58 | +?> |
| Index: trunk/phase3/includes/api/ApiPageSet.php |
| — | — | @@ -1,6 +1,5 @@ |
| 2 | 2 | <?php |
| 3 | 3 | |
| 4 | | - |
| 5 | 4 | /* |
| 6 | 5 | * Created on Sep 24, 2006 |
| 7 | 6 | * |
| — | — | @@ -29,6 +28,9 @@ |
| 30 | 29 | require_once ('ApiQueryBase.php'); |
| 31 | 30 | } |
| 32 | 31 | |
| | 32 | +/** |
| | 33 | + * @addtogroup API |
| | 34 | + */ |
| 33 | 35 | class ApiPageSet extends ApiQueryBase { |
| 34 | 36 | |
| 35 | 37 | private $mAllPages; // [ns][dbkey] => page_id or 0 when missing |
| Index: trunk/phase3/includes/api/ApiQueryLogEvents.php |
| — | — | @@ -1,6 +1,5 @@ |
| 2 | 2 | <?php |
| 3 | 3 | |
| 4 | | - |
| 5 | 4 | /* |
| 6 | 5 | * Created on Oct 16, 2006 |
| 7 | 6 | * |
| — | — | @@ -29,6 +28,9 @@ |
| 30 | 29 | require_once ('ApiQueryBase.php'); |
| 31 | 30 | } |
| 32 | 31 | |
| | 32 | +/** |
| | 33 | + * @addtogroup API |
| | 34 | + */ |
| 33 | 35 | class ApiQueryLogEvents extends ApiQueryBase { |
| 34 | 36 | |
| 35 | 37 | public function __construct($query, $moduleName) { |
| Index: trunk/phase3/includes/api/ApiQueryRecentChanges.php |
| — | — | @@ -1,6 +1,5 @@ |
| 2 | 2 | <?php |
| 3 | 3 | |
| 4 | | - |
| 5 | 4 | /* |
| 6 | 5 | * Created on Oct 19, 2006 |
| 7 | 6 | * |
| — | — | @@ -29,6 +28,9 @@ |
| 30 | 29 | require_once ('ApiQueryBase.php'); |
| 31 | 30 | } |
| 32 | 31 | |
| | 32 | +/** |
| | 33 | + * @addtogroup API |
| | 34 | + */ |
| 33 | 35 | class ApiQueryRecentChanges extends ApiQueryBase { |
| 34 | 36 | |
| 35 | 37 | public function __construct($query, $moduleName) { |
| — | — | @@ -184,4 +186,4 @@ |
| 185 | 187 | return __CLASS__ . ': $Id$'; |
| 186 | 188 | } |
| 187 | 189 | } |
| 188 | | -?> |
| \ No newline at end of file |
| | 190 | +?> |
| Index: trunk/phase3/includes/api/ApiQueryBase.php |
| — | — | @@ -1,6 +1,5 @@ |
| 2 | 2 | <?php |
| 3 | 3 | |
| 4 | | - |
| 5 | 4 | /* |
| 6 | 5 | * Created on Sep 7, 2006 |
| 7 | 6 | * |
| — | — | @@ -29,6 +28,9 @@ |
| 30 | 29 | require_once ('ApiBase.php'); |
| 31 | 30 | } |
| 32 | 31 | |
| | 32 | +/** |
| | 33 | + * @addtogroup API |
| | 34 | + */ |
| 33 | 35 | abstract class ApiQueryBase extends ApiBase { |
| 34 | 36 | |
| 35 | 37 | private $mQueryModule, $tables, $where, $fields, $options; |
| — | — | @@ -341,6 +343,9 @@ |
| 342 | 344 | } |
| 343 | 345 | } |
| 344 | 346 | |
| | 347 | +/** |
| | 348 | + * @addtogroup API |
| | 349 | + */ |
| 345 | 350 | abstract class ApiQueryGeneratorBase extends ApiQueryBase { |
| 346 | 351 | |
| 347 | 352 | private $mIsGenerator; |
| Index: trunk/phase3/includes/api/ApiFormatPhp.php |
| — | — | @@ -1,6 +1,5 @@ |
| 2 | 2 | <?php |
| 3 | 3 | |
| 4 | | - |
| 5 | 4 | /* |
| 6 | 5 | * Created on Oct 22, 2006 |
| 7 | 6 | * |
| — | — | @@ -29,6 +28,9 @@ |
| 30 | 29 | require_once ('ApiFormatBase.php'); |
| 31 | 30 | } |
| 32 | 31 | |
| | 32 | +/** |
| | 33 | + * @addtogroup API |
| | 34 | + */ |
| 33 | 35 | class ApiFormatPhp extends ApiFormatBase { |
| 34 | 36 | |
| 35 | 37 | public function __construct($main, $format) { |
| — | — | @@ -51,4 +53,4 @@ |
| 52 | 54 | return __CLASS__ . ': $Id$'; |
| 53 | 55 | } |
| 54 | 56 | } |
| 55 | | -?> |
| \ No newline at end of file |
| | 57 | +?> |
| Index: trunk/phase3/includes/AjaxResponse.php |
| — | — | @@ -5,6 +5,7 @@ |
| 6 | 6 | |
| 7 | 7 | /** |
| 8 | 8 | * @todo document |
| | 9 | + * @addtogroup Ajax |
| 9 | 10 | */ |
| 10 | 11 | class AjaxResponse { |
| 11 | 12 | var $mCacheDuration; |
| Index: trunk/phase3/includes/SpecialNewpages.php |
| — | — | @@ -5,7 +5,7 @@ |
| 6 | 6 | */ |
| 7 | 7 | |
| 8 | 8 | /** |
| 9 | | - * |
| | 9 | + * implements Special:Newpages |
| 10 | 10 | * @addtogroup SpecialPage |
| 11 | 11 | */ |
| 12 | 12 | class NewPagesPage extends QueryPage { |
| Index: trunk/phase3/includes/SpecialResetpass.php |
| — | — | @@ -5,6 +5,9 @@ |
| 6 | 6 | $form->execute( $par ); |
| 7 | 7 | } |
| 8 | 8 | |
| | 9 | +/** |
| | 10 | + * @addtogroup SpecialPage |
| | 11 | + */ |
| 9 | 12 | class PasswordResetForm extends SpecialPage { |
| 10 | 13 | function __construct( $name=null, $reset=null ) { |
| 11 | 14 | if( $name !== null ) { |
| Index: trunk/phase3/includes/ProfilerSimple.php |
| — | — | @@ -5,6 +5,7 @@ |
| 6 | 6 | /** |
| 7 | 7 | * Simple profiler base class. |
| 8 | 8 | * @todo document methods (?) |
| | 9 | + * @addtogroup Profiler |
| 9 | 10 | */ |
| 10 | 11 | class ProfilerSimple extends Profiler { |
| 11 | 12 | var $mMinimumTime = 0; |
| Index: trunk/phase3/includes/Pager.php |
| — | — | @@ -2,6 +2,7 @@ |
| 3 | 3 | |
| 4 | 4 | /** |
| 5 | 5 | * Basic pager interface. |
| | 6 | + * @addtogroup Pager |
| 6 | 7 | */ |
| 7 | 8 | interface Pager { |
| 8 | 9 | function getNavigationBar(); |
| — | — | @@ -46,6 +47,8 @@ |
| 47 | 48 | * please see the examples in PageHistory.php and SpecialIpblocklist.php. You just need |
| 48 | 49 | * to override formatRow(), getQueryInfo() and getIndexField(). Don't forget to call the |
| 49 | 50 | * parent constructor if you override it. |
| | 51 | + * |
| | 52 | + * @addtogroup Pager |
| 50 | 53 | */ |
| 51 | 54 | abstract class IndexPager implements Pager { |
| 52 | 55 | public $mRequest; |
| — | — | @@ -389,7 +392,8 @@ |
| 390 | 393 | |
| 391 | 394 | /** |
| 392 | 395 | * IndexPager with an alphabetic list and a formatted navigation bar |
| 393 | | -*/ |
| | 396 | + * @addtogroup Pager |
| | 397 | + */ |
| 394 | 398 | abstract class AlphabeticPager extends IndexPager { |
| 395 | 399 | public $mDefaultDirection = false; |
| 396 | 400 | |
| — | — | @@ -423,6 +427,7 @@ |
| 424 | 428 | |
| 425 | 429 | /** |
| 426 | 430 | * IndexPager with a formatted navigation bar |
| | 431 | + * @addtogroup Pager |
| 427 | 432 | */ |
| 428 | 433 | abstract class ReverseChronologicalPager extends IndexPager { |
| 429 | 434 | public $mDefaultDirection = true; |
| — | — | @@ -455,6 +460,7 @@ |
| 456 | 461 | |
| 457 | 462 | /** |
| 458 | 463 | * Table-based display with a user-selectable sort order |
| | 464 | + * @addtogroup Pager |
| 459 | 465 | */ |
| 460 | 466 | abstract class TablePager extends IndexPager { |
| 461 | 467 | var $mSort; |
| Index: trunk/phase3/includes/SpecialPopularpages.php |
| — | — | @@ -5,7 +5,7 @@ |
| 6 | 6 | */ |
| 7 | 7 | |
| 8 | 8 | /** |
| 9 | | - * |
| | 9 | + * implements Special:Popularpages |
| 10 | 10 | * @addtogroup SpecialPage |
| 11 | 11 | */ |
| 12 | 12 | class PopularPagesPage extends QueryPage { |
| Index: trunk/phase3/includes/SpecialSearch.php |
| — | — | @@ -42,7 +42,7 @@ |
| 43 | 43 | } |
| 44 | 44 | |
| 45 | 45 | /** |
| 46 | | - * @todo document |
| | 46 | + * implements Special:Search - Run text & title search and display the output |
| 47 | 47 | * @addtogroup SpecialPage |
| 48 | 48 | */ |
| 49 | 49 | class SpecialSearch { |
| Index: trunk/phase3/includes/Sanitizer.php |
| — | — | @@ -315,6 +315,10 @@ |
| 316 | 316 | 'zwj' => 8205, |
| 317 | 317 | 'zwnj' => 8204 ); |
| 318 | 318 | |
| | 319 | +/** |
| | 320 | + * XHTML sanitizer for MediaWiki |
| | 321 | + * @addtogroup Parser |
| | 322 | + */ |
| 319 | 323 | class Sanitizer { |
| 320 | 324 | /** |
| 321 | 325 | * Cleans up HTML, removes dangerous tags and attributes, and |
| Index: trunk/phase3/includes/templates/Userlogin.php |
| — | — | @@ -92,6 +92,9 @@ |
| 93 | 93 | } |
| 94 | 94 | } |
| 95 | 95 | |
| | 96 | +/** |
| | 97 | + * @addtogroup Templates |
| | 98 | + */ |
| 96 | 99 | class UsercreateTemplate extends QuickTemplate { |
| 97 | 100 | function execute() { |
| 98 | 101 | if( $this->data['message'] ) { |
| Index: trunk/phase3/includes/SpecialMostlinked.php |
| — | — | @@ -1,7 +1,8 @@ |
| 2 | 2 | <?php |
| 3 | 3 | |
| 4 | 4 | /** |
| 5 | | - * A special page to show pages ordered by the number of pages linking to them |
| | 5 | + * A special page to show pages ordered by the number of pages linking to them. |
| | 6 | + * Implements Special:Mostlinked |
| 6 | 7 | * |
| 7 | 8 | * @addtogroup SpecialPage |
| 8 | 9 | * |
| — | — | @@ -11,10 +12,6 @@ |
| 12 | 13 | * @copyright © 2006 Rob Church |
| 13 | 14 | * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License 2.0 or later |
| 14 | 15 | */ |
| 15 | | - |
| 16 | | -/** |
| 17 | | - * @addtogroup SpecialPage |
| 18 | | - */ |
| 19 | 16 | class MostlinkedPage extends QueryPage { |
| 20 | 17 | |
| 21 | 18 | function getName() { return 'Mostlinked'; } |
| Index: trunk/phase3/includes/SpecialUncategorizedcategories.php |
| — | — | @@ -10,7 +10,7 @@ |
| 11 | 11 | require_once( "SpecialUncategorizedpages.php" ); |
| 12 | 12 | |
| 13 | 13 | /** |
| 14 | | - * |
| | 14 | + * implements Special:Uncategorizedcategories |
| 15 | 15 | * @addtogroup SpecialPage |
| 16 | 16 | */ |
| 17 | 17 | class UncategorizedCategoriesPage extends UncategorizedPagesPage { |
| Index: trunk/phase3/includes/ParserOutput.php |
| — | — | @@ -1,6 +1,7 @@ |
| 2 | 2 | <?php |
| 3 | 3 | /** |
| 4 | 4 | * @todo document |
| | 5 | + * @addtogroup Parser |
| 5 | 6 | */ |
| 6 | 7 | class ParserOutput |
| 7 | 8 | { |
| Index: trunk/phase3/includes/User.php |
| — | — | @@ -17,6 +17,7 @@ |
| 18 | 18 | |
| 19 | 19 | /** |
| 20 | 20 | * Thrown by User::setPassword() on error |
| | 21 | + * @addtogroup Exception |
| 21 | 22 | */ |
| 22 | 23 | class PasswordError extends MWException { |
| 23 | 24 | // NOP |
| Index: trunk/phase3/includes/SpecialImagelist.php |
| — | — | @@ -23,6 +23,10 @@ |
| 24 | 24 | . $nav ); |
| 25 | 25 | } |
| 26 | 26 | |
| | 27 | +/** |
| | 28 | + * @addtogroup SpecialPage |
| | 29 | + * @addtogroup Pager |
| | 30 | + */ |
| 27 | 31 | class ImageListPager extends TablePager { |
| 28 | 32 | var $mFieldNames = null; |
| 29 | 33 | var $mMessages = array(); |
| Index: trunk/phase3/includes/SpecialUnusedtemplates.php |
| — | — | @@ -1,6 +1,7 @@ |
| 2 | 2 | <?php |
| 3 | 3 | |
| 4 | 4 | /** |
| | 5 | + * implements Special:Unusedtemplates |
| 5 | 6 | * @author Rob Church <robchur@gmail.com> |
| 6 | 7 | * @copyright © 2006 Rob Church |
| 7 | 8 | * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License 2.0 or later |