Fix function level comments that start with /* not /**
authorSam Reed <reedy@users.mediawiki.org>
Sat, 21 May 2011 19:35:16 +0000 (19:35 +0000)
committerSam Reed <reedy@users.mediawiki.org>
Sat, 21 May 2011 19:35:16 +0000 (19:35 +0000)
20 files changed:
includes/Article.php
includes/ChangesFeed.php
includes/ConfEditor.php
includes/EditPage.php
includes/MimeMagic.php
includes/Title.php
includes/db/DatabaseSqlite.php
includes/db/LBFactory.php
includes/filerepo/File.php
includes/filerepo/FileRepo.php
includes/filerepo/ForeignAPIRepo.php
includes/installer/SqliteInstaller.php
includes/media/BMP.php
includes/media/Generic.php
includes/media/SVG.php
includes/media/SVGMetadataExtractor.php
includes/media/XMP.php
includes/objectcache/BagOStuff.php
includes/parser/CoreParserFunctions.php
includes/search/SearchPostgres.php

index ff8546f..a3f3799 100644 (file)
@@ -2703,7 +2703,7 @@ class Article {
        }
 
 
-       /*
+       /**
         * UI entry point for page deletion
         */
        public function delete() {
index 23fb923..49ee33c 100644 (file)
@@ -61,11 +61,11 @@ class ChangesFeed {
 
                FeedUtils::checkPurge( $timekey, $key );
 
-               /*
-               * Bumping around loading up diffs can be pretty slow, so where
-               * possible we want to cache the feed output so the next visitor
-               * gets it quick too.
-               */
+               /**
+                * Bumping around loading up diffs can be pretty slow, so where
+                * possible we want to cache the feed output so the next visitor
+                * gets it quick too.
+                */
                $cachedFeed = $this->loadFromCache( $lastmod, $timekey, $key );
                if( is_string( $cachedFeed ) ) {
                        wfDebug( "RC: Outputting cached feed\n" );
@@ -110,12 +110,12 @@ class ChangesFeed {
                $feedLastmod = $messageMemc->get( $timekey );
 
                if( ( $wgFeedCacheTimeout > 0 ) && $feedLastmod ) {
-                       /*
-                       * If the cached feed was rendered very recently, we may
-                       * go ahead and use it even if there have been edits made
-                       * since it was rendered. This keeps a swarm of requests
-                       * from being too bad on a super-frequently edited wiki.
-                       */
+                   /**
+                        * If the cached feed was rendered very recently, we may
+                        * go ahead and use it even if there have been edits made
+                        * since it was rendered. This keeps a swarm of requests
+                        * from being too bad on a super-frequently edited wiki.
+                        */
 
                        $feedAge = time() - wfTimestamp( TS_UNIX, $feedLastmod );
                        $feedLastmodUnix = wfTimestamp( TS_UNIX, $feedLastmod );
index 324a475..5294684 100644 (file)
@@ -472,7 +472,7 @@ class ConfEditor {
                return $extraPath;
        }
 
-       /*
+       /**
         * Find the path name of first element in the array.
         * If the array is empty, this will return the \@extra interstitial element.
         * If the specified path is not found or is not an array, it will return false.
index 48dd317..36e28d0 100644 (file)
@@ -287,7 +287,7 @@ class EditPage {
                return '';
        }
 
-       /*
+       /**
         * Check if a page was deleted while the user was editing it, before submit.
         * Note that we rely on the logging table, which hasn't been always there,
         * but that doesn't matter, because this only applies to brand new
@@ -1882,7 +1882,7 @@ HTML
                $wgOut->addHTML( "</div><!-- editButtons -->\n</div><!-- editOptions -->\n" );
        }
 
-       /*
+       /**
         * Show an edit conflict. textbox1 is already shown in showEditForm().
         * If you want to use another entry point to this function, be careful.
         */
index de32dcc..b19c0ba 100644 (file)
@@ -157,11 +157,11 @@ class MimeMagic {
        private static $extensionLoaded = false;
 
        /** Initializes the MimeMagic object. This is called by MimeMagic::singleton().
-       *
-       * This constructor parses the mime.types and mime.info files and build internal mappings.
-       */
+        *
+        * This constructor parses the mime.types and mime.info files and build internal mappings.
+        */
        function __construct() {
-               /*
+               /**
                *   --- load mime.types ---
                */
 
@@ -244,9 +244,9 @@ class MimeMagic {
                        }
                }
 
-               /*
-               *   --- load mime.info ---
-               */
+               /**
+                *   --- load mime.info ---
+                */
 
                global $wgMimeInfoFile;
                if ( $wgMimeInfoFile == 'includes/mime.info' ) {
@@ -628,7 +628,7 @@ class MimeMagic {
                        return "image/webp";
                }
 
-               /*
+               /**
                 * Look for PHP.  Check for this before HTML/XML...  Warning: this is a
                 * heuristic, and won't match a file with a lot of non-PHP before.  It
                 * will also match text files which could be PHP. :)
@@ -652,7 +652,7 @@ class MimeMagic {
                        return 'application/x-php';
                }
 
-               /*
+               /**
                 * look for XML formats (XHTML and SVG)
                 */
                $xml = new XmlTypeCheck( $file );
@@ -665,7 +665,7 @@ class MimeMagic {
                        }
                }
 
-               /*
+               /**
                 * look for shell scripts
                 */
                $script_type = null;
index 6328284..3a4c3fe 100644 (file)
@@ -1770,7 +1770,7 @@ class Title {
                                # Not a public wiki, so no shortcut
                                $useShortcut = false;
                        } elseif ( !empty( $wgRevokePermissions ) ) {
-                               /*
+                               /**
                                 * Iterate through each group with permissions being revoked (key not included since we don't care
                                 * what the group name is), then check if the read permission is being revoked. If it is, then
                                 * we don't use the shortcut below since the user might not be able to read, even though anon
index f4a6c02..be8e781 100644 (file)
@@ -620,7 +620,7 @@ class DatabaseSqlite extends DatabaseBase {
                return $s;
        }
 
-       /*
+       /**
         * Build a concatenation list to feed into a SQL query
         *
         * @return string
index af2acaa..3e2e453 100644 (file)
@@ -80,7 +80,7 @@ abstract class LBFactory {
         */
        abstract function getMainLB( $wiki = false );
 
-       /*
+       /**
         * Create a new load balancer for external storage. The resulting object will be
         * untracked, not chronology-protected, and the caller is responsible for
         * cleaning it up.
@@ -90,7 +90,7 @@ abstract class LBFactory {
         */
        abstract function newExternalLB( $cluster, $wiki = false );
 
-       /*
+       /**
         * Get a cached (tracked) load balancer for external storage
         *
         * @param $cluster String: external storage cluster, or false for core
index 6f9c639..7fafc62 100644 (file)
@@ -930,6 +930,7 @@ abstract class File {
        function getRepoName() {
                return $this->repo ? $this->repo->getName() : 'unknown';
        }
+
        /*
         * Returns the repository
         */
index 6e4d12f..c4059bf 100644 (file)
@@ -150,7 +150,7 @@ abstract class FileRepo {
                return false;
        }
 
-       /*
+       /**
         * Find many files at once.
         * @param $items An array of titles, or an array of findFile() options with
         *    the "title" option giving the title. Example:
index c461d4d..cf73218 100644 (file)
@@ -216,7 +216,7 @@ class ForeignAPIRepo extends FileRepo {
                }
        }
 
-       /*
+       /**
         * Return the imageurl from cache if possible
         *
         * If the url has been requested today, get it from cache
index 189815a..a33082f 100644 (file)
@@ -45,7 +45,7 @@ class SqliteInstaller extends DatabaseInstaller {
                        $this->getTextBox( 'wgDBname', 'config-db-name', array(), $this->parent->getHelpBox( 'config-sqlite-name-help' ) );
        }
 
-       /*
+       /**
         * Safe wrapper for PHP's realpath() that fails gracefully if it's unable to canonicalize the path.
         */
        private static function realpath( $path ) {
index de836b5..bc8381a 100644 (file)
@@ -23,7 +23,7 @@ class BmpHandler extends BitmapHandler {
                return array( 'png', 'image/png' );
        }
 
-       /*
+       /**
         * Get width and height from the bmp header.
         */
        function getImageSize( $image, $filename ) {
index 7901fd7..fb8f257 100644 (file)
@@ -48,7 +48,7 @@ abstract class MediaHandler {
         */
        abstract function getParamMap();
 
-       /*
+       /**
         * Validate a thumbnail parameter at parse time.
         * Return true to accept the parameter, and false to reject it.
         * If you return false, the parser will do something quiet and forgiving.
index 57a9668..de0307d 100644 (file)
@@ -105,7 +105,7 @@ class SvgHandler extends ImageHandler {
                }
        }
 
-       /*
+       /**
        * Transform an SVG file to PNG
        * This function can be called outside of thumbnail contexts
        * @param string $srcPath
index b5c8df1..8f11f93 100644 (file)
@@ -83,14 +83,14 @@ class SVGReader {
                wfRestoreWarnings();
        }
 
-       /*
+       /**
         * @return Array with the known metadata
         */
        public function getMetadata() {
                return $this->metadata;
        }
 
-       /*
+       /**
         * Read the SVG
         */
        public function read() {
@@ -142,7 +142,7 @@ class SVGReader {
                return true;
        }
 
-       /*
+       /**
         * Read a textelement from an element
         *
         * @param String $name of the element that we are reading from
@@ -179,7 +179,7 @@ class SVGReader {
                $this->reader->next();
        }
 
-       /*
+       /**
         * Filter all children, looking for animate elements
         *
         * @param String $name of the element that we are reading from
@@ -238,7 +238,7 @@ class SVGReader {
                wfDebug( "SVGReader WARN: $data\n" );
        }
 
-       /*
+       /**
         * Parse the attributes of an SVG element
         *
         * The parser has to be in the start element of <svg>
index d426f30..b950647 100644 (file)
@@ -40,7 +40,7 @@ class XMPReader {
 
        protected $items;
 
-       /*
+       /**
        * These are various mode constants.
        * they are used to figure out what to do
        * with an element when its encountered.
index 9512853..fd0f621 100644 (file)
@@ -64,7 +64,7 @@ abstract class BagOStuff {
         */
        abstract public function set( $key, $value, $exptime = 0 );
 
-       /*
+       /**
         * Delete an item.
         * @param $key string
         * @param $time int Amount of time to delay the operation (mostly memcached-specific)
index 403e7a3..1710837 100644 (file)
@@ -442,10 +442,11 @@ class CoreParserFunctions {
                        return '';
                return wfUrlencode( $t->getSubjectNsText() );
        }
-       /*
+
+       /**
         * Functions to get and normalize pagenames, corresponding to the magic words
         * of the same names
-       */
+        */
        static function pagename( $parser, $title = null ) {
                $t = Title::newFromText( $title );
                if ( is_null( $t ) )
index 0e5dc9b..b0590d0 100644 (file)
@@ -67,11 +67,10 @@ class SearchPostgres extends SearchEngine {
                return new PostgresSearchResultSet( $resultSet, $this->searchTerms );
        }
 
-
-       /*
+       /**
         * Transform the user's search string into a better form for tsearch2
         * Returns an SQL fragment consisting of quoted text to search for.
-       */
+        */
        function parseQuery( $term ) {
 
                wfDebug( "parseQuery received: $term \n" );