Revert r20769: we don't use PHPDocumentor anymore, we use doxygen.
authorBrion Vibber <brion@users.mediawiki.org>
Wed, 28 Mar 2007 14:16:43 +0000 (14:16 +0000)
committerBrion Vibber <brion@users.mediawiki.org>
Wed, 28 Mar 2007 14:16:43 +0000 (14:16 +0000)
If making mass changes to tweak to its preferences, probably better to do it for the tool we actually generate docs with. :)

53 files changed:
includes/AjaxDispatcher.php
includes/AjaxResponse.php
includes/Article.php
includes/Categoryfinder.php
includes/ChangesList.php
includes/Database.php
includes/DatabaseOracle.php
includes/DateFormatter.php
includes/DefaultSettings.php
includes/DifferenceEngine.php
includes/DjVuImage.php
includes/EditPage.php
includes/Exif.php
includes/Feed.php
includes/FileStore.php
includes/GlobalFunctions.php
includes/HTMLCacheUpdate.php
includes/HistoryBlob.php
includes/IP.php
includes/JobQueue.php
includes/Licenses.php
includes/LinkCache.php
includes/LinksUpdate.php
includes/LogPage.php
includes/OutputPage.php
includes/Parser.php
includes/ParserCache.php
includes/ProfilerSimple.php
includes/ProfilerSimpleUDP.php
includes/ProtectionForm.php
includes/Sanitizer.php
includes/SkinTemplate.php
includes/SpecialAncientpages.php
includes/SpecialBlockip.php
includes/SpecialEmailuser.php
includes/SpecialImport.php
includes/SpecialIpblocklist.php
includes/SpecialListredirects.php
includes/SpecialLockdb.php
includes/SpecialLog.php
includes/SpecialMIMEsearch.php
includes/SpecialMovepage.php
includes/SpecialProtectedpages.php
includes/SpecialRandomredirect.php
includes/SpecialUndelete.php
includes/SpecialUserlogin.php
includes/SpecialVersion.php
includes/Title.php
includes/User.php
includes/UserMailer.php
includes/WebRequest.php
includes/api/ApiBase.php
includes/api/ApiFormatYaml_spyc.php

index bb4709b..4a84ea2 100644 (file)
@@ -9,9 +9,6 @@ if ( ! $wgUseAjax ) {
 
 require_once( 'AjaxFunctions.php' );
 
-/**
- * @todo Document - e.g. Provide top-level description of this class.
- */
 class AjaxDispatcher {
        var $mode;
        var $func_name;
index a814e57..c3c15ad 100644 (file)
@@ -3,9 +3,7 @@ if( !defined( 'MEDIAWIKI' ) ) {
        die( 1 );
 }
 
-/**
- * @todo document
- */
+/** @todo document */
 class AjaxResponse {
        var $mCacheDuration;
        var $mVary;
index bef53e4..3dd47a0 100644 (file)
@@ -12,7 +12,7 @@
  *
  */
 class Article {
-       /**
+       /**@{{
         * @private
         */
        var $mComment;                  //!<
@@ -34,7 +34,7 @@ class Article {
        var $mTouched;                  //!<
        var $mUser;                             //!<
        var $mUserText;                 //!<
-       /** end private properties */
+       /**@}}*/
 
        /**
         * Constructor and clear the article
@@ -2348,7 +2348,7 @@ class Article {
         *
         * @param Revision $rev
         *
-        * @todo This is a shitty interface function. Kill it and replace the
+        * @fixme This is a shitty interface function. Kill it and replace the
         * other shitty functions like editUpdates and such so it's not needed
         * anymore.
         */
index fd75d77..773c6b2 100644 (file)
@@ -1,26 +1,26 @@
 <?php
+/*
+The "Categoryfinder" class takes a list of articles, creates an internal representation of all their parent
+categories (as well as parents of parents etc.). From this representation, it determines which of these articles
+are in one or all of a given subset of categories.
+
+Example use :
+
+       # Determines wether the article with the page_id 12345 is in both
+       # "Category 1" and "Category 2" or their subcategories, respectively
+       
+       $cf = new Categoryfinder ;
+       $cf->seed (
+               array ( 12345 ) ,
+               array ( "Category 1","Category 2" ) ,
+               "AND"
+       ) ;
+       $a = $cf->run() ;
+       print implode ( "," , $a ) ;
+
+*/
+
 
-/**
- * The "Categoryfinder" class takes a list of articles, creates an internal representation of all their parent
- * categories (as well as parents of parents etc.). From this representation, it determines which of these articles
- * are in one or all of a given subset of categories.
- * 
- * Example use :
- * 
- *     # Determines wether the article with the page_id 12345 is in both
- *     # "Category 1" and "Category 2" or their subcategories, respectively
- *     
- *     $cf = new Categoryfinder ;
- *     $cf->seed (
- *             array ( 12345 ) ,
- *             array ( "Category 1","Category 2" ) ,
- *             "AND"
- *     ) ;
- *     $a = $cf->run() ;
- *     print implode ( "," , $a ) ;
- * 
- * 
- */
 class Categoryfinder {
 
        var $articles = array () ; # The original article IDs passed to the seed function
index bc14157..43fd543 100644 (file)
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Contain class to show various lists of change:
+ * - what's link here
+ * - related changes
+ * - recent changes
+ */
 
 /**
  * @todo document
@@ -18,10 +24,6 @@ class RCCacheEntry extends RecentChange
 } ;
 
 /**
- * Class to show various lists of changes:
- * - what links here
- * - related changes
- * - recent changes
  */
 class ChangesList {
        # Called by history lists and recent changes
index 0b1462c..4bfc84b 100644 (file)
@@ -15,9 +15,6 @@ define( 'DEADLOCK_DELAY_MAX', 1500000 );
  * Utility classes
  *****************************************************************************/
 
-/**
- * Utility class.
- */
 class DBObject {
        public $mData;
 
@@ -34,9 +31,6 @@ class DBObject {
        }
 };
 
-/**
- * Utility class.
- */
 class MySQLField {
        private $name, $tablename, $default, $max_length, $nullable,
                $is_pk, $is_unique, $is_key, $type;
@@ -465,12 +459,14 @@ class Database {
 # Other functions
 #------------------------------------------------------------------------------
 
-       /**
-        * Constructor.
+       /**@{{
         * @param string $server database server host
         * @param string $user database user name
         * @param string $password database user password
         * @param string $dbname database name
+        */
+
+       /**
         * @param failFunction
         * @param $flags
         * @param $tablePrefix String: database table prefixes. By default use the prefix gave in LocalSettings.php
@@ -611,6 +607,7 @@ class Database {
                wfProfileOut( __METHOD__ );
                return $success;
        }
+       /**@}}*/
 
        /**
         * Closes a database connection.
@@ -1487,7 +1484,7 @@ class Database {
        }
        
        /**
-        * Fetch a number of table names into an zero-indexed numerical array
+        * @desc: Fetch a number of table names into an zero-indexed numerical array
         * This is handy when you need to construct SQL for joins
         *
         * Example:
index a15978e..7560039 100644 (file)
@@ -3,6 +3,7 @@
 /**
  * This is the Oracle database abstraction layer.
  */
+
 class ORABlob {
        var $mData;
 
@@ -13,9 +14,9 @@ class ORABlob {
        function getData() {
                return $this->mData;
        }
-}
+};
 
-/**
+/*
  * 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.
index 88a6445..643da7b 100644 (file)
@@ -1,7 +1,11 @@
 <?php
-
 /**
  * Date formatter, recognises dates in plain text and formats them accoding to user preferences.
+ *
+ * @addtogroup Parser
+ */
+
+/**
  * @todo preferences, OutputPage
  * @addtogroup Parser
  */
index 20a7e5a..4a2babc 100644 (file)
@@ -307,8 +307,8 @@ $wgVerifyMimeType= true;
 /** Sets the mime type definition file to use by MimeMagic.php.
 * @global string $wgMimeTypeFile
 */
-$wgMimeTypeFile= "includes/mime.types";
 #$wgMimeTypeFile= "/etc/mime.types";
+$wgMimeTypeFile= "includes/mime.types";
 #$wgMimeTypeFile= NULL; #use built-in defaults only.
 
 /** Sets the mime type info file to use by MimeMagic.php.
index a065ab4..e6218b6 100644 (file)
@@ -1,7 +1,6 @@
 <?php
 /**
  * See diff.doc
- * @todo indicate where diff.doc can be found.
  * @addtogroup DifferenceEngine
  */
 
@@ -1332,7 +1331,8 @@ class Diff
 }
 
 /**
- * @todo document, bad name.
+ * FIXME: bad name.
+ * @todo document
  * @private
  * @addtogroup DifferenceEngine
  */
index f983184..7872cf0 100644 (file)
@@ -1,6 +1,11 @@
 <?php
-
 /**
+ * Support for detecting/validating DjVu image files and getting
+ * some basic file metadata (resolution etc)
+ *
+ * File format docs are available in source package for DjVuLibre:
+ * http://djvulibre.djvuzone.org/
+ *
  *
  * Copyright (C) 2006 Brion Vibber <brion@pobox.com>
  * http://www.mediawiki.org/
  *
  */
 
-/**
- * Support for detecting/validating DjVu image files and getting
- * some basic file metadata (resolution etc)
- *
- * File format docs are available in source package for DjVuLibre:
- * http://djvulibre.djvuzone.org/
- */
 class DjVuImage {
        function __construct( $filename ) {
                $this->mFilename = $filename;
index 74983ee..4246955 100644 (file)
@@ -1,14 +1,16 @@
 <?php
 /**
- * Contains the EditPage class
+ * Contain the EditPage class
  */
 
 /**
- * The edit page/HTML interface (split from Article)
+ * Splitting edit page/HTML interface from Article...
  * The actual database and text munging is still in Article,
  * but it should get easier to call those from alternate
  * interfaces.
+ *
  */
+
 class EditPage {
        var $mArticle;
        var $mTitle;
index 84d8e8d..9bca6fd 100644 (file)
  * http://www.gnu.org/copyleft/gpl.html
  *
  * @link http://exif.org/Exif2-2.PDF The Exif 2.2 specification
+ * @bug 1555, 1947
  */
 
 /**
- * @todo document (e.g. one-sentence class-overview description)
  * @addtogroup Metadata
  */
 class Exif {
@@ -597,7 +597,6 @@ class Exif {
 }
 
 /**
- * @todo document (e.g. one-sentence class-overview description)
  * @addtogroup Metadata
  */
 class FormatExif {
index a77dcbc..6967426 100644 (file)
@@ -1,5 +1,6 @@
 <?php
-
+# Basic support for outputting syndication feeds in RSS, other formats
+#
 # Copyright (C) 2004 Brion Vibber <brion@pobox.com>
 # http://www.mediawiki.org/
 #
 # http://www.gnu.org/copyleft/gpl.html
 
 /**
- * Basic support for outputting syndication feeds in RSS, other formats.
  * Contain a feed class as well as classes to build rss / atom ... feeds
  * Available feeds are defined in Defines.php
  */
 
+
 /**
- * @todo document (needs one-sentence top-level class description + function descriptions).
+ * @todo document
  */
 class FeedItem {
        /**#@+
@@ -74,7 +75,7 @@ class FeedItem {
 }
 
 /**
- * @todo document (needs one-sentence top-level class description).
+ * @todo document
  */
 class ChannelFeed extends FeedItem {
        /**#@+
@@ -156,6 +157,7 @@ class ChannelFeed extends FeedItem {
 
 /**
  * Generate a RSS feed
+ * @todo document
  */
 class RSSFeed extends ChannelFeed {
 
@@ -215,6 +217,7 @@ class RSSFeed extends ChannelFeed {
 
 /**
  * Generate an Atom feed
+ * @todo document
  */
 class AtomFeed extends ChannelFeed {
        /**
index 3d02bfa..1fd35b0 100644 (file)
@@ -1,8 +1,5 @@
 <?php
 
-/**
- * @todo document (needs one-sentence top-level class description).
- */
 class FileStore {
        const DELETE_ORIGINAL = 1;
        
@@ -36,7 +33,7 @@ class FileStore {
         * suffer an uncaught error the lock will be released when the
         * connection is closed.
         *
-        * @todo Probably only works on MySQL. Abstract to the Database class?
+        * @fixme Probably only works on MySQL. Abstract to the Database class?
         */
        static function lock() {
                global $wgDBtype;
@@ -178,7 +175,7 @@ class FileStore {
         * @throws FSException if file can't be deleted
         * @return FSTransaction
         *
-        * @todo Might be worth preliminary permissions check
+        * @fixme Might be worth preliminary permissions check
         */
        static function deleteFile( $path ) {
                if( file_exists( $path ) ) {
index 58b5e2c..345b763 100644 (file)
@@ -558,11 +558,11 @@ function wfMsgWikiHtml( $key ) {
  * Returns message in the requested format
  * @param string $key Key of the message
  * @param array $options Processing rules:
- *  <i>parse</i>: parses wikitext to html
- *  <i>parseinline</i>: parses wikitext to html and removes the surrounding p's added by parser or tidy
- *  <i>escape</i>: filters message trough htmlspecialchars
- *  <i>replaceafter</i>: parameters are substituted after parsing or escaping
- *  <i>parsemag</i>: transform the message using magic phrases
+ *  <i>parse<i>: parses wikitext to html
+ *  <i>parseinline<i>: parses wikitext to html and removes the surrounding p's added by parser or tidy
+ *  <i>escape<i>: filters message trough htmlspecialchars
+ *  <i>replaceafter<i>: parameters are substituted after parsing or escaping
+ *  <i>parsemag<i>: transform the message using magic phrases
  */
 function wfMsgExt( $key, $options ) {
        global $wgOut, $wgParser;
@@ -612,7 +612,7 @@ function wfMsgExt( $key, $options ) {
  * Just like exit() but makes a note of it.
  * Commits open transactions except if the error parameter is set
  *
- * @deprecated Please return control to the caller or throw an exception
+ * @obsolete Please return control to the caller or throw an exception
  */
 function wfAbruptExit( $error = false ){
        global $wgLoadBalancer;
@@ -642,7 +642,7 @@ function wfAbruptExit( $error = false ){
 }
 
 /**
- * @deprecated Please return control the caller or throw an exception
+ * @obsolete Please return control the caller or throw an exception
  */
 function wfErrorExit() {
        wfAbruptExit( true );
@@ -1401,7 +1401,7 @@ define('TS_ISO_8601', 4);
 /**
  * An Exif timestamp (YYYY:MM:DD HH:MM:SS)
  *
- * @link http://exif.org/Exif2-2.PDF The Exif 2.2 spec, see page 28 for the
+ * @url http://exif.org/Exif2-2.PDF The Exif 2.2 spec, see page 28 for the
  *       DateTime tag and page 36 for the DateTimeOriginal and
  *       DateTimeDigitized tags.
  */
index 9a0b6a0..cc392d9 100644 (file)
@@ -184,9 +184,6 @@ class HTMLCacheUpdate
        }
 }
 
-/**
- * @todo document (e.g. one-sentence top-level class description).
- */
 class HTMLCacheUpdateJob extends Job {
        var $table, $start, $end;
 
index 282a7f5..3ce4ffd 100644 (file)
@@ -5,7 +5,6 @@
 
 /**
  * Pure virtual parent
- * @todo document (needs a one-sentence top-level class description, that answers the question: "what is a HistoryBlob?") 
  */
 class HistoryBlob
 {
@@ -49,7 +48,6 @@ class HistoryBlob
 
 /**
  * The real object
- * @todo document (needs one-sentence top-level class description + function descriptions).
  */
 class ConcatenatedGzipHistoryBlob extends HistoryBlob
 {
@@ -178,7 +176,6 @@ $wgBlobCache = array();
 
 
 /**
- * @todo document (needs one-sentence top-level class description + some function descriptions).
  */
 class HistoryBlobStub {
        var $mOldId, $mHash, $mRef;
@@ -196,16 +193,16 @@ class HistoryBlobStub {
                $this->mOldId = $id;
        }
 
-       /**
-        * Sets the location (old_id) of the referring object
-        */
+      /**
+       * Sets the location (old_id) of the referring object
+       */
        function setReferrer( $id ) {
                $this->mRef = $id;
        }
 
-       /**
-        * Gets the location of the referring object
-        */
+      /**
+       * Gets the location of the referring object
+       */
        function getReferrer() {
                return $this->mRef;
        }
@@ -272,6 +269,7 @@ class HistoryBlobStub {
  *
  * Serialized HistoryBlobCurStub objects will be inserted into the text table
  * on conversion if $wgFastSchemaUpgrades is set to true.
+ *
  */
 class HistoryBlobCurStub {
        var $mCurId;
index d9906c5..748a1f0 100644 (file)
@@ -1,5 +1,8 @@
 <?php
 /*
+ * Collection of public static functions to play with IP address
+ * and IP blocks.
+ *
  * @Author "Ashar Voultoiz" <hashar@altern.org>
  * @License GPL v2 or later
  */
@@ -24,10 +27,6 @@ define( 'RE_IPV6_BLOCK', RE_IPV6_ADD . '\/' . RE_IPV6_PREFIX );
 // This might be useful for regexps used elsewhere, matches any IPv6 or IPv6 address or network
 define( 'IP_ADDRESS_STRING', RE_IP_ADD . '(\/' . RE_IP_PREFIX . '|)|' . RE_IPV6_ADD . '(\/' . RE_IPV6_PREFIX . '|)');
 
-/**
- * A collection of public static functions to play with IP address
- * and IP blocks.
- */
 class IP {
        /**
         * Given a string, determine if it as valid IP
index b6ed6c3..54af5e7 100644 (file)
@@ -4,9 +4,6 @@ if ( !defined( 'MEDIAWIKI' ) ) {
        die( "This file is part of MediaWiki, it is not a valid entry point\n" );
 }
 
-/**
- * @todo document (e.g. one-sentence top-level class description).
- */
 abstract class Job {
        var $command,
                $title,
@@ -241,10 +238,6 @@ abstract class Job {
        }
 }
 
-
-/**
- * @todo document (e.g. one-sentence top-level class description).
- */
 class RefreshLinksJob extends Job {
        function __construct( $title, $params = '', $id = 0 ) {
                parent::__construct( 'refreshLinks', $title, $params, $id );
index f4586ae..bd7494a 100644 (file)
@@ -1,7 +1,7 @@
 <?php
 /**
  * A License class for use on Special:Upload
- * 
+ *
  * @addtogroup SpecialPage
  *
  * @author Ævar Arnfjörð Bjarmason <avarab@gmail.com>
@@ -146,9 +146,6 @@ class Licenses {
        function getHtml() { return $this->html; }
 }
 
-/**
- * A License class for use on Special:Upload (represents a single type of license).
- */
 class License {
        /**
         * @var string
index 53fb640..14072c5 100644 (file)
@@ -1,7 +1,10 @@
 <?php
 /**
  * Cache for article titles (prefixed DB keys) and ids linked from one source
- * 
+ * @addtogroup Cache
+ */
+
+/**
  * @addtogroup Cache
  */
 class LinkCache {
index 755fb29..bd6e241 100644 (file)
@@ -1,12 +1,14 @@
 <?php
 /**
- * See docs/deferred.txt
- * 
- * @todo document (e.g. one-sentence top-level class description).
+ * See deferred.txt
+ */
+
+/**
+ * @todo document
  */
 class LinksUpdate {
 
-       /**
+       /**@{{
         * @private
         */
        var $mId,            //!< Page ID of the article linked from
@@ -20,7 +22,7 @@ class LinksUpdate {
                $mDb,            //!< Database connection reference
                $mOptions,       //!< SELECT options to be used (array)
                $mRecursive;     //!< Whether to queue jobs for recursive updates
-       /** end private attributes */
+       /**@}}*/
 
        /**
         * Constructor
index af03bbb..ecab3d8 100644 (file)
@@ -117,7 +117,7 @@ class LogPage {
        }
 
        /**
-        * @todo handle missing log types
+        * @fixme: handle missing log types
         * @static
         */
        function logHeader( $type ) {
index b94fd22..ba719a9 100644 (file)
@@ -766,7 +766,7 @@ class OutputPage {
                $this->returnToMain( false );
        }
 
-       /** @deprecated */
+       /** @obsolete */
        public function errorpage( $title, $msg ) {
                throw new ErrorPageError( $title, $msg );
        }
@@ -876,7 +876,7 @@ class OutputPage {
                        $this->returnToMain( true, $mainPage );
        }
 
-       /** @deprecated */
+       /** @obsolete */
        public function databaseError( $fname, $sql, $error, $errno ) {
                throw new MWException( "OutputPage::databaseError is obsolete\n" );
        }
@@ -940,32 +940,32 @@ class OutputPage {
                $this->returnToMain( false );
        }
 
-       /** @deprecated */
+       /** @obsolete */
        public function fatalError( $message ) {
                throw new FatalError( $message ); 
        }
        
-       /** @deprecated */
+       /** @obsolete */
        public function unexpectedValueError( $name, $val ) {
                throw new FatalError( wfMsg( 'unexpected', $name, $val ) );
        }
 
-       /** @deprecated */
+       /** @obsolete */
        public function fileCopyError( $old, $new ) {
                throw new FatalError( wfMsg( 'filecopyerror', $old, $new ) );
        }
 
-       /** @deprecated */
+       /** @obsolete */
        public function fileRenameError( $old, $new ) {
                throw new FatalError( wfMsg( 'filerenameerror', $old, $new ) );
        }
 
-       /** @deprecated */
+       /** @obsolete */
        public function fileDeleteError( $name ) {
                throw new FatalError( wfMsg( 'filedeleteerror', $name ) );
        }
 
-       /** @deprecated */
+       /** @obsolete */
        public function fileNotFoundError( $name ) {
                throw new FatalError( wfMsg( 'filenotfound', $name ) );
        }
index ece25fb..f5fbaa2 100644 (file)
@@ -56,10 +56,9 @@ define( 'MW_COLON_STATE_COMMENTDASH', 6 );
 define( 'MW_COLON_STATE_COMMENTDASHDASH', 7 );
 
 /**
- * PHP Parser - Processes wiki markup (which uses a more user-friendly 
- * syntax, such as "[[link]]" for making links), and provides a one-way
- * transformation of that wiki markup it into XHTML output / markup
- * (which in turn the browser understands, and can display).
+ * PHP Parser
+ *
+ * Processes wiki markup
  *
  * <pre>
  * There are four main entry points into the Parser class:
@@ -1469,7 +1468,7 @@ class Parser
         * @param string
         * @return string
         * @static
-        * @todo  This can merge genuinely required bits in the path or query string,
+        * @fixme This can merge genuinely required bits in the path or query string,
         *        breaking legit URLs. A proper fix would treat the various parts of
         *        the URL differently; as a workaround, just use the output for
         *        statistical records, not for actual linking/output.
@@ -4703,9 +4702,6 @@ class Parser
 
 }
 
-/**
- * @todo document, briefly.
- */
 class OnlyIncludeReplacer {
        var $output = '';
 
@@ -4718,9 +4714,6 @@ class OnlyIncludeReplacer {
        }
 }
 
-/**
- * @todo document, briefly.
- */
 class StripState {
        var $general, $nowiki;
 
index 752aa54..d31f7ef 100644 (file)
@@ -5,7 +5,7 @@
  */
 
 /**
- * @todo document
+ *
  */
 class ParserCache {
        /**
index a52af25..a118c85 100644 (file)
@@ -1,11 +1,13 @@
 <?php
-
-require_once(dirname(__FILE__).'/Profiler.php');
+/**
+ * Simple profiler base class
+ */
 
 /**
- * Simple profiler base class.
- * @todo document methods (?)
+ * @todo document
  */
+require_once(dirname(__FILE__).'/Profiler.php');
+
 class ProfilerSimple extends Profiler {
        var $mMinimumTime = 0;
        var $mProfileID = false;
index a8ca97f..a9bce07 100644 (file)
@@ -1,12 +1,11 @@
 <?php
+/* ProfilerSimpleUDP class, that sends out messages for 'udpprofile' daemon
+   (the one from mediawiki/trunk/udpprofile SVN )
+*/
 
 require_once(dirname(__FILE__).'/Profiler.php');
 require_once(dirname(__FILE__).'/ProfilerSimple.php');
 
-/**
- * ProfilerSimpleUDP class, that sends out messages for 'udpprofile' daemon
- * (the one from mediawiki/trunk/udpprofile SVN )
- */
 class ProfilerSimpleUDP extends ProfilerSimple {
        function getFunctionReport() {
                global $wgUDPProfilerHost;
index b2f5e2a..659ba1f 100644 (file)
@@ -21,9 +21,6 @@
  * @addtogroup SpecialPage
  */
 
-/**
- * @todo document, briefly.
- */
 class ProtectionForm {
        var $mRestrictions = array();
        var $mReason = '';
index b702188..51c751c 100644 (file)
@@ -723,6 +723,8 @@ class Sanitizer {
         *                                                          name attributes
         * @link http://www.w3.org/TR/html401/struct/links.html#h-12.2.3 Anchors with the id attribute
         *
+        * @bug 4461
+        *
         * @static
         *
         * @param string $id
index 6023bf0..05eda0c 100644 (file)
@@ -66,7 +66,7 @@ class MediaWiki_I18N {
 }
 
 /**
- * @todo document with one-sentence top-level class description.
+ *
  */
 class SkinTemplate extends Skin {
        /**#@+
index 4b52b6a..8894f5b 100644 (file)
@@ -5,7 +5,7 @@
  */
 
 /**
- * @todo document, briefly.
+ *
  * @addtogroup SpecialPage
  */
 class AncientPagesPage extends QueryPage {
index 5b73ef4..602f6db 100644 (file)
@@ -37,7 +37,7 @@ function wfSpecialBlockip( $par ) {
 }
 
 /**
- * Form object for the Special:Blockip page.
+ * Form object
  *
  * @addtogroup SpecialPage
  */
index b49812b..2f4ce67 100644 (file)
@@ -4,11 +4,11 @@
  * @addtogroup SpecialPage
  */
 
-require_once('UserMailer.php');
-
 /**
- * @todo document
+ *
  */
+require_once('UserMailer.php');
+
 function wfSpecialEmailuser( $par ) {
        global $wgUser, $wgOut, $wgRequest, $wgEnableEmail, $wgEnableUserEmail;
 
index 44a6bc2..10ab239 100644 (file)
@@ -771,9 +771,6 @@ class WikiImporter {
 
 }
 
-/**
- * @todo document (e.g. one-sentence class description).
- */
 class ImportStringSource {
        function ImportStringSource( $string ) {
                $this->mString = $string;
@@ -794,9 +791,6 @@ class ImportStringSource {
        }
 }
 
-/**
- * @todo document (e.g. one-sentence class description).
- */
 class ImportStreamSource {
        function ImportStreamSource( $handle ) {
                $this->mHandle = $handle;
index e5c285c..6ba3e55 100644 (file)
@@ -45,7 +45,7 @@ function wfSpecialIpblocklist() {
 }
 
 /**
- * @todo document
+ *
  * @addtogroup SpecialPage
  */
 class IPUnblockForm {
@@ -319,9 +319,6 @@ class IPUnblockForm {
        }
 }
 
-/**
- * @todo document
- */
 class IPBlocklistPager extends ReverseChronologicalPager {
        public $mForm, $mConds;
 
index 09dc2b3..bc39692 100644 (file)
@@ -8,9 +8,9 @@
  */
 
 /**
- * Special:Listredirects - Lists all the redirects on the wiki.
  * @addtogroup SpecialPage
  */
+
 class ListredirectsPage extends QueryPage {
 
        function getName() { return( 'Listredirects' ); }
index 929e028..57c20b7 100644 (file)
@@ -36,7 +36,7 @@ function wfSpecialLockdb() {
 }
 
 /**
- * @todo document - e.g. a one-sentence top-level class description.
+ *
  * @addtogroup SpecialPage
  */
 class DBLockForm {
index fcce6df..d258d59 100644 (file)
@@ -36,7 +36,7 @@ function wfSpecialLog( $par = '' ) {
 }
 
 /**
- * @todo document (needs one-sentence top-level class description)
+ *
  * @addtogroup SpecialPage
  */
 class LogReader {
@@ -218,7 +218,7 @@ class LogReader {
 }
 
 /**
- * @todo document (needs one-sentence top-level class description)
+ *
  * @addtogroup SpecialPage
  */
 class LogViewer {
index d50efc0..1e69b23 100644 (file)
@@ -10,8 +10,6 @@
  */
 
 /**
- * Searches the database for files of the requested MIME type, comparing this with the
- * 'img_major_mime' and 'img_minor_mime' fields in the image table.
  * @addtogroup SpecialPage
  */
 class MIMEsearchPage extends QueryPage {
@@ -79,7 +77,7 @@ class MIMEsearchPage extends QueryPage {
 }
 
 /**
- * Output the HTML search form, and constructs the MIMEsearchPage object.
+ * constructor
  */
 function wfSpecialMIMEsearch( $par = null ) {
        global $wgRequest, $wgTitle, $wgOut;
index 062a68a..6a3e03e 100644 (file)
@@ -41,7 +41,7 @@ function wfSpecialMovepage( $par = null ) {
 }
 
 /**
- * HTML form for Special:Movepage
+ *
  * @addtogroup SpecialPage
  */
 class MovePageForm {
index b214822..26c4212 100644 (file)
@@ -5,7 +5,7 @@
  */
 
 /**
- * @todo document
+ *
  * @addtogroup SpecialPage
  */
 class ProtectedPagesForm {
@@ -185,7 +185,8 @@ class ProtectedPagesForm {
 }
 
 /**
- * @todo document
+ *
+ *
  */
 class ProtectedPagesPager extends ReverseChronologicalPager {
        public $mForm, $mConds;
index 60e9d65..40df984 100644 (file)
@@ -5,7 +5,7 @@
  *
  * @addtogroup Special pages
  * @author Rob Church <robchur@gmail.com>
- * @license GNU General Public Licence 2.0 or later
+ * @licence GNU General Public Licence 2.0 or later
  */
 
 /**
index 36d3669..e450884 100644 (file)
@@ -18,7 +18,7 @@ function wfSpecialUndelete( $par ) {
 }
 
 /**
- * @todo document (just needs one-sentence top-level class description)
+ *
  * @addtogroup SpecialPage
  */
 class PageArchive {
@@ -114,7 +114,7 @@ class PageArchive {
         * if not a file page.
         *
         * @return ResultWrapper
-        * @todo Does this belong in Image for fuller encapsulation?
+        * @fixme Does this belong in Image for fuller encapsulation?
         */
        function listFiles() {
                if( $this->title->getNamespace() == NS_IMAGE ) {
@@ -456,8 +456,7 @@ class PageArchive {
 }
 
 /**
- * The HTML form for Special:Undelete, which allows users with the appropriate
- * permissions to view and restore deleted content.
+ *
  * @addtogroup SpecialPage
  */
 class UndeleteForm {
index 879886c..a34558f 100644 (file)
@@ -19,7 +19,7 @@ function wfSpecialUserlogin() {
 }
 
 /**
- * @todo document, briefly.
+ *
  * @addtogroup SpecialPage
  */
 
index 1aee8cd..5bc1318 100644 (file)
@@ -4,6 +4,8 @@
  *
  * @addtogroup SpecialPage
  *
+ * @bug 2019, 4531
+ *
  * @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
@@ -261,6 +263,8 @@ class SpecialVersion {
        /**
         * Retrieve the revision number of a Subversion working directory.
         *
+        * @bug 7335
+        *
         * @param string $dir
         * @return mixed revision number as int, or false if not a SVN checkout
         */
index 8705dd0..070cd24 100644 (file)
@@ -1229,7 +1229,7 @@ class Title {
        /**
         * Can $wgUser read this page?
         * @return boolean
-        * @todo fold these checks into userCan()
+        * @fixme fold these checks into userCan()
         */
        public function userCanRead() {
                global $wgUser;
@@ -1354,7 +1354,7 @@ class Title {
         * Cascading protection: Return true if cascading restrictions apply to this page, false if not.
         *
         * @return bool If the page is subject to cascading restrictions.
-        * @access public
+        * @access public.
         */
        function isCascadeProtected() {
                list( $sources, $restrictions ) = $this->getCascadeProtectionSources( false );
@@ -1902,8 +1902,7 @@ class Title {
         * members directly, which is what Linker::formatComment was doing previously.
         *
         * @param string $fragment text
-        * @access public
-        * @todo clarify whether access is supposed to be public (was marked as "kind of public")
+        * @access kind of public
         */
        function setFragment( $fragment ) {
                $this->mFragment = str_replace( '_', ' ', substr( $fragment, 1 ) );
index 8cdad6c..a4630b8 100644 (file)
@@ -350,6 +350,8 @@ class User {
         * addresses like this, if we allowed accounts like this to be created
         * new users could get the old edits of these anonymous users.
         *
+        * @bug 3631
+        *
         * @static
         * @param string $name Nickname of a user
         * @return bool
@@ -497,7 +499,8 @@ class User {
         * rejected valid addresses. Actually just check if there is '@' somewhere
         * in the given address.
         *
-        * @todo Check for RFC 2822 compilance (bug 959)
+        * @todo Check for RFC 2822 compilance
+        * @bug 959
         *
         * @param string $addr email address
         * @static
@@ -599,7 +602,7 @@ class User {
 
        /**
         * Return a random password. Sourced from mt_rand, so it's not particularly secure.
-        * @todo hash random numbers to improve security, like generateToken()
+        * @todo: hash random numbers to improve security, like generateToken()
         *
         * @return string
         * @static
@@ -1648,7 +1651,7 @@ class User {
        /**
         * Add the user to the given group.
         * This takes immediate effect.
-        * @param string $group
+        * @string $group
         */
        function addGroup( $group ) {
                $this->load();
@@ -1672,7 +1675,7 @@ class User {
        /**
         * Remove the user from the given group.
         * This takes immediate effect.
-        * @param string $group
+        * @string $group
         */
        function removeGroup( $group ) {
                $this->load();
@@ -1943,7 +1946,7 @@ class User {
 
        /**
         * Save object settings into database
-        * @todo Only rarely do all these fields need to be set!
+        * @fixme Only rarely do all these fields need to be set!
         */
        function saveSettings() {
                $this->load();
index f3524f5..b2d1a4f 100644 (file)
@@ -32,11 +32,6 @@ function wfRFC822Phrase( $phrase ) {
        return '"' . $phrase . '"';
 }
 
-/**
- * Stores a single person's name and email address.
- * These are passed in via the constructor, and will be returned in SMTP
- * header format when requested.
- */
 class MailAddress {
        /**
         * @param mixed $address String with an email address, or a User object
@@ -196,12 +191,14 @@ function mailErrorHandler( $code, $string ) {
  *
  */
 class EmailNotification {
-       /**
-        * @private member variables:
+       /**@{{
+        * @private
         */
        var $to, $subject, $body, $replyto, $from;
        var $user, $title, $timestamp, $summary, $minorEdit, $oldid;
 
+       /**@}}*/
+
        /**
         * @todo document
         * @param $title Title object
index 1962ce9..6c058af 100644 (file)
 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 # http://www.gnu.org/copyleft/gpl.html
 
-
-/**
- * Some entry points may use this file without first enabling the 
- * autoloader.
- */
-if ( !function_exists( '__autoload' ) ) {
-       require_once( dirname(__FILE__) . '/normal/UtfNormal.php' );
-}
-
 /**
  * The WebRequest class encapsulates getting at data passed in the
  * URL or via a POSTed form, handling remove of "magic quotes" slashes,
@@ -41,6 +32,15 @@ if ( !function_exists( '__autoload' ) ) {
  * input.
  *
  */
+
+/**
+ * Some entry points may use this file without first enabling the 
+ * autoloader.
+ */
+if ( !function_exists( '__autoload' ) ) {
+       require_once( dirname(__FILE__) . '/normal/UtfNormal.php' );
+}
+
 class WebRequest {
        function __construct() {
                $this->checkMagicQuotes();
index a29e336..c2dd93b 100644 (file)
@@ -24,9 +24,6 @@
  * http://www.gnu.org/copyleft/gpl.html
  */
 
-/**
- * @todo Document - e.g. Provide top-level description of this class.
- */
 abstract class ApiBase {
 
        // These constants allow modules to specify exactly how to treat incomming parameters.
index fa049cf..579fa5c 100644 (file)
    * @addtogroup Spyc
    */
   class YAMLNode {
-    /**
+    /**#@+
      * @access public
      * @var string
      */ 
     var $parent;
     var $id;
+    /**#@+*/
     /** 
      * @access public
      * @var mixed
   
     /**** Private Properties ****/
     
-    /**
+    /**#@+
      * @access private
      * @var mixed
      */ 
     var $_isInline;
     var $_dumpIndent;
     var $_dumpWordWrap;
+    /**#@+*/
 
     /**** Private Methods ****/