Replaced all @fixme with "@todo Fixme" since doxygen doesn't have a @fixme command
authorAlexandre Emsenhuber <ialex@users.mediawiki.org>
Tue, 15 Dec 2009 21:26:58 +0000 (21:26 +0000)
committerAlexandre Emsenhuber <ialex@users.mediawiki.org>
Tue, 15 Dec 2009 21:26:58 +0000 (21:26 +0000)
17 files changed:
includes/ConfEditor.php
includes/Import.php
includes/Linker.php
includes/OutputHandler.php
includes/Revision.php
includes/Sanitizer.php
includes/WebRequest.php
includes/filerepo/ForeignAPIFile.php
includes/media/Generic.php
includes/parser/Parser.php
includes/specials/SpecialContributions.php
includes/specials/SpecialDeletedContributions.php
includes/specials/SpecialExport.php
includes/specials/SpecialUndelete.php
languages/classes/LanguageGan.php
languages/classes/LanguageYue.php
languages/classes/LanguageZh_hans.php

index d8b3da8..f862ebb 100644 (file)
@@ -306,14 +306,14 @@ class ConfEditor {
        function parseScalar( $str ) {
                if ( $str !== '' && $str[0] == '\'' )
                        // Single-quoted string
-                       // @fixme trim() call is due to mystery bug where whitespace gets
+                       // @todo Fixme: trim() call is due to mystery bug where whitespace gets
                        // appended to the token; without it we ended up reading in the
                        // extra quote on the end!
                        return strtr( substr( trim( $str ), 1, -1 ),
                                array( '\\\'' => '\'', '\\\\' => '\\' ) );
                if ( $str !== '' && @$str[0] == '"' )
                        // Double-quoted string
-                       // @fixme trim() call is due to mystery bug where whitespace gets
+                       // @todo Fixme: trim() call is due to mystery bug where whitespace gets
                        // appended to the token; without it we ended up reading in the
                        // extra quote on the end!
                        return stripcslashes( substr( trim( $str ), 1, -1 ) );
index 5bc28cb..45908a6 100644 (file)
@@ -304,7 +304,7 @@ class WikiRevision {
                                $resultDetails = array( 'internal' => $status->getWikiText() );
                */
 
-               // @fixme upload() uses $wgUser, which is wrong here
+               // @todo Fixme: upload() uses $wgUser, which is wrong here
                // it may also create a page without our desire, also wrong potentially.
                // and, it will record a *current* upload, but we might want an archive version here
 
@@ -352,7 +352,7 @@ class WikiRevision {
                        return false;
                }
 
-               // @fixme!
+               // @todo Fixme!
                $src = $this->getSrc();
                $data = Http::get( $src );
                if( !$data ) {
index c0258c0..2c16db4 100644 (file)
@@ -751,7 +751,7 @@ class Linker {
         * @param String $linktype Type of external link. Gets added to the classes
         * @param array $attribs Array of extra attributes to <a>
         * 
-        * @TODO! @FIXME! This is a really crappy implementation. $linktype and 
+        * @todo FIXME: This is a really crappy implementation. $linktype and 
         * 'external' are mashed into the class attrib for the link (which is made
         * into a string). Then, if we've got additional params in $attribs, we 
         * add to it. People using this might want to change the classes (or other
@@ -1027,7 +1027,7 @@ class Linker {
         * Formats wiki links and media links in text; all other wiki formatting
         * is ignored
         *
-        * @fixme doesn't handle sub-links as in image thumb texts like the main parser
+        * @todo Fixme: doesn't handle sub-links as in image thumb texts like the main parser
         * @param string $comment Text to format links in
         * @return string
         */
index a4fc047..061f750 100644 (file)
@@ -37,7 +37,7 @@ function wfOutputHandler( $s ) {
  * @private
  */
 function wfRequestExtension() {
-       /// @fixme -- this sort of dupes some code in WebRequest::getRequestUrl()
+       /// @todo Fixme: this sort of dupes some code in WebRequest::getRequestUrl()
        if( isset( $_SERVER['REQUEST_URI'] ) ) {
                // Strip the query string...
                list( $path ) = explode( '?', $_SERVER['REQUEST_URI'], 2 );
index 93c1120..3e30361 100644 (file)
@@ -70,7 +70,7 @@ class Revision {
        /**
         * Make a fake revision object from an archive table row. This is queried
         * for permissions or even inserted (as in Special:Undelete)
-        * @fixme: should be a subclass for RevisionDelete. [TS]
+        * @todo Fixme: should be a subclass for RevisionDelete. [TS]
         */
        public static function newFromArchiveRow( $row, $overrides = array() ) {
                $attribs = $overrides + array(
index bdc8362..9370583 100644 (file)
@@ -1439,7 +1439,7 @@ class Sanitizer {
 
                        $host = preg_replace( $strip, '', $host );
 
-                       // @fixme: validate hostnames here
+                       // @todo Fixme: validate hostnames here
 
                        return $protocol . $host . $rest;
                } else {
index 28472e6..894f83e 100644 (file)
@@ -47,7 +47,7 @@ class WebRequest {
        private $_response;
 
        public function __construct() {
-               /// @fixme This preemptive de-quoting can interfere with other web libraries
+               /// @todo Fixme: this preemptive de-quoting can interfere with other web libraries
                ///        and increases our memory footprint. It would be cleaner to do on
                ///        demand; but currently we have no wrapper for $_SERVER etc.
                $this->checkMagicQuotes();
index f4c02ba..f798fec 100644 (file)
@@ -108,7 +108,7 @@ class ForeignAPIFile extends File {
                return $this->mInfo['mime'];
        }
        
-       /// @fixme May guess wrong on file types that can be eg audio or video
+       /// @todo Fixme: may guess wrong on file types that can be eg audio or video
        function getMediaType() {
                $magic = MimeMagic::singleton();
                return $magic->getMediaType( null, $this->getMimeType() );
index b1c6394..ee24cd8 100644 (file)
@@ -218,7 +218,7 @@ abstract class MediaHandler {
        }
 
        /**
-        * @fixme document this!
+        * @todo Fixme: document this!
         * 'value' thingy goes into a wikitext table; it used to be escaped but
         * that was incompatible with previous practice of customized display
         * with wikitext formatting via messages such as 'exif-model-value'.
index 30a80b4..c6cd361 100644 (file)
@@ -275,7 +275,7 @@ class Parser
         */
        function uniqPrefix() {
                if( !isset( $this->mUniqPrefix ) ) {
-                       // @fixme this is probably *horribly wrong*
+                       // @todo Fixme: this is probably *horribly wrong*
                        // LanguageConverter seems to want $wgParser's uniqPrefix, however
                        // if this is called for a parser cache hit, the parser may not
                        // have ever been initialized in the first place.
@@ -4570,7 +4570,7 @@ class Parser
                                                switch( $paramName ) {
                                                case 'manualthumb':
                                                case 'alt':
-                                                       // @fixme - possibly check validity here for
+                                                       // @todo Fixme: possibly check validity here for
                                                        // manualthumb? downstream behavior seems odd with
                                                        // missing manual thumbs.
                                                        $validated = true;
index ce3c9c9..00029ea 100644 (file)
@@ -142,7 +142,7 @@ class SpecialContributions extends SpecialPage {
         * @param Title $nt @see Title object for the target
         * @param integer $id User ID for the target
         * @return String: appropriately-escaped HTML to be output literally
-        * @fixme Almost the same as getSubTitle in SpecialDeletedContributions.php. Could be combined.
+        * @todo Fixme: almost the same as getSubTitle in SpecialDeletedContributions.php. Could be combined.
         */
        protected function contributionsSub( $nt, $id ) {
                global $wgSysopUserBans, $wgLang, $wgUser, $wgOut;
index 995f680..5d1e43c 100644 (file)
@@ -331,7 +331,7 @@ class DeletedContributionsPage extends SpecialPage {
         * @param Title $nt @see Title object for the target
         * @param integer $id User ID for the target
         * @return String: appropriately-escaped HTML to be output literally
-        * @fixme Almost the same as contributionsSub in SpecialContributions.php. Could be combined.
+        * @todo Fixme: almost the same as contributionsSub in SpecialContributions.php. Could be combined.
         */
        function getSubTitle( $nt, $id ) {
                global $wgSysopUserBans, $wgLang, $wgUser, $wgOut;
index 6469640..bce2a10 100644 (file)
@@ -55,7 +55,7 @@ class SpecialExport extends SpecialPage {
                                $t = Title::makeTitleSafe( NS_MAIN, $catname );
                                if ( $t ) {
                                        /**
-                                        * @fixme This can lead to hitting memory limit for very large
+                                        * @todo Fixme: this can lead to hitting memory limit for very large
                                         * categories. Ideally we would do the lookup synchronously
                                         * during the export in a single query.
                                         */
@@ -70,7 +70,7 @@ class SpecialExport extends SpecialPage {
                        
                        if ( strval( $nsindex ) !== ''  ) {
                                /**
-                                * Same implementation as above, so same @fixme
+                                * Same implementation as above, so same @todo
                                 */
                                $nspages = $this->getPagesFromNamespace( $nsindex );
                                if ( $nspages ) $page .= "\n" . implode( "\n", $nspages );
@@ -393,7 +393,7 @@ class SpecialExport extends SpecialPage {
                        $title = Title::newFromText( $page );
                        if( $title ) {
                                $pageSet[$title->getPrefixedText()] = true;
-                               /// @fixme May or may not be more efficient to batch these
+                               /// @todo Fixme: May or may not be more efficient to batch these
                                ///        by namespace when given multiple input pages.
                                $result = $dbr->select(
                                                                           array( 'page', $table ),
index 443b845..722d231 100644 (file)
@@ -887,14 +887,14 @@ class UndeleteForm {
                $sk = $wgUser->getSkin();
                $isDeleted = !( $rev->getId() && $rev->getTitle() );
                if( $isDeleted ) {
-                       /// @fixme $rev->getTitle() is null for deleted revs...?
+                       /// @todo Fixme: $rev->getTitle() is null for deleted revs...?
                        $targetPage = SpecialPage::getTitleFor( 'Undelete' );
                        $targetQuery = array(
                                'target' => $this->mTargetObj->getPrefixedText(),
                                'timestamp' => wfTimestamp( TS_MW, $rev->getTimestamp() )
                        );
                } else {
-                       /// @fixme getId() may return non-zero for deleted revs...
+                       /// @todo Fixme getId() may return non-zero for deleted revs...
                        $targetPage = $rev->getTitle();
                        $targetQuery = array( 'oldid' => $rev->getId() );
                }
index f454105..151a99c 100644 (file)
@@ -142,7 +142,7 @@ class LanguageGan extends LanguageZh {
 
                // eventually this should be a word segmentation
                // for now just treat each character as a word
-               // @fixme only do this for Han characters...
+               // @todo Fixme: only do this for Han characters...
                $t = preg_replace(
                                "/([\\xc0-\\xff][\\x80-\\xbf]*)/",
                                " $1", $string);
index fc7f233..4191fba 100644 (file)
@@ -8,7 +8,7 @@ class LanguageYue extends Language {
 
                // eventually this should be a word segmentation
                // for now just treat each character as a word
-               // @fixme only do this for Han characters...
+               // @todo Fixme: only do this for Han characters...
                $t = preg_replace(
                                "/([\\xc0-\\xff][\\x80-\\xbf]*)/",
                                " $1", $string);
index 081737c..ce542fd 100644 (file)
@@ -15,7 +15,7 @@ class LanguageZh_hans extends Language {
                // Note we put a space on both sides to cover cases
                // where a number or Latin char follows a Han char.
                //
-               // @fixme only do this for Han characters...
+               // @todo Fixme: only do this for Han characters...
                $t = preg_replace(
                                "/([\\xc0-\\xff][\\x80-\\xbf]*)/",
                                " $1 ", $string);