From e514478ba52bbae35955dc9b23e9a015aa86cdaf Mon Sep 17 00:00:00 2001 From: Sam Reed Date: Sat, 21 May 2011 19:35:16 +0000 Subject: [PATCH] Fix function level comments that start with /* not /** --- includes/Article.php | 2 +- includes/ChangesFeed.php | 22 +++++++++++----------- includes/ConfEditor.php | 2 +- includes/EditPage.php | 4 ++-- includes/MimeMagic.php | 20 ++++++++++---------- includes/Title.php | 2 +- includes/db/DatabaseSqlite.php | 2 +- includes/db/LBFactory.php | 4 ++-- includes/filerepo/File.php | 1 + includes/filerepo/FileRepo.php | 2 +- includes/filerepo/ForeignAPIRepo.php | 2 +- includes/installer/SqliteInstaller.php | 2 +- includes/media/BMP.php | 2 +- includes/media/Generic.php | 2 +- includes/media/SVG.php | 2 +- includes/media/SVGMetadataExtractor.php | 10 +++++----- includes/media/XMP.php | 2 +- includes/objectcache/BagOStuff.php | 2 +- includes/parser/CoreParserFunctions.php | 5 +++-- includes/search/SearchPostgres.php | 5 ++--- 20 files changed, 48 insertions(+), 47 deletions(-) diff --git a/includes/Article.php b/includes/Article.php index ff8546f074..a3f3799aab 100644 --- a/includes/Article.php +++ b/includes/Article.php @@ -2703,7 +2703,7 @@ class Article { } - /* + /** * UI entry point for page deletion */ public function delete() { diff --git a/includes/ChangesFeed.php b/includes/ChangesFeed.php index 23fb923921..49ee33ce03 100644 --- a/includes/ChangesFeed.php +++ b/includes/ChangesFeed.php @@ -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 ); diff --git a/includes/ConfEditor.php b/includes/ConfEditor.php index 324a4754b2..5294684a40 100644 --- a/includes/ConfEditor.php +++ b/includes/ConfEditor.php @@ -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. diff --git a/includes/EditPage.php b/includes/EditPage.php index 48dd3172c5..36e28d01b9 100644 --- a/includes/EditPage.php +++ b/includes/EditPage.php @@ -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( "\n\n" ); } - /* + /** * Show an edit conflict. textbox1 is already shown in showEditForm(). * If you want to use another entry point to this function, be careful. */ diff --git a/includes/MimeMagic.php b/includes/MimeMagic.php index de32dccdd4..b19c0ba506 100644 --- a/includes/MimeMagic.php +++ b/includes/MimeMagic.php @@ -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; diff --git a/includes/Title.php b/includes/Title.php index 6328284814..3a4c3fe657 100644 --- a/includes/Title.php +++ b/includes/Title.php @@ -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 diff --git a/includes/db/DatabaseSqlite.php b/includes/db/DatabaseSqlite.php index f4a6c02859..be8e7812b3 100644 --- a/includes/db/DatabaseSqlite.php +++ b/includes/db/DatabaseSqlite.php @@ -620,7 +620,7 @@ class DatabaseSqlite extends DatabaseBase { return $s; } - /* + /** * Build a concatenation list to feed into a SQL query * * @return string diff --git a/includes/db/LBFactory.php b/includes/db/LBFactory.php index af2acaa4dc..3e2e453866 100644 --- a/includes/db/LBFactory.php +++ b/includes/db/LBFactory.php @@ -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 diff --git a/includes/filerepo/File.php b/includes/filerepo/File.php index 6f9c6397df..7fafc62a3f 100644 --- a/includes/filerepo/File.php +++ b/includes/filerepo/File.php @@ -930,6 +930,7 @@ abstract class File { function getRepoName() { return $this->repo ? $this->repo->getName() : 'unknown'; } + /* * Returns the repository */ diff --git a/includes/filerepo/FileRepo.php b/includes/filerepo/FileRepo.php index 6e4d12f372..c4059bf5f2 100644 --- a/includes/filerepo/FileRepo.php +++ b/includes/filerepo/FileRepo.php @@ -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: diff --git a/includes/filerepo/ForeignAPIRepo.php b/includes/filerepo/ForeignAPIRepo.php index c461d4dfc9..cf7321803c 100644 --- a/includes/filerepo/ForeignAPIRepo.php +++ b/includes/filerepo/ForeignAPIRepo.php @@ -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 diff --git a/includes/installer/SqliteInstaller.php b/includes/installer/SqliteInstaller.php index 189815af16..a33082fcfe 100644 --- a/includes/installer/SqliteInstaller.php +++ b/includes/installer/SqliteInstaller.php @@ -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 ) { diff --git a/includes/media/BMP.php b/includes/media/BMP.php index de836b595d..bc8381a3d0 100644 --- a/includes/media/BMP.php +++ b/includes/media/BMP.php @@ -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 ) { diff --git a/includes/media/Generic.php b/includes/media/Generic.php index 7901fd7c80..fb8f25786c 100644 --- a/includes/media/Generic.php +++ b/includes/media/Generic.php @@ -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. diff --git a/includes/media/SVG.php b/includes/media/SVG.php index 57a96683c0..de0307df57 100644 --- a/includes/media/SVG.php +++ b/includes/media/SVG.php @@ -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 diff --git a/includes/media/SVGMetadataExtractor.php b/includes/media/SVGMetadataExtractor.php index b5c8df11cf..8f11f937b3 100644 --- a/includes/media/SVGMetadataExtractor.php +++ b/includes/media/SVGMetadataExtractor.php @@ -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 diff --git a/includes/media/XMP.php b/includes/media/XMP.php index d426f308da..b950647aab 100644 --- a/includes/media/XMP.php +++ b/includes/media/XMP.php @@ -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. diff --git a/includes/objectcache/BagOStuff.php b/includes/objectcache/BagOStuff.php index 951285330d..fd0f621312 100644 --- a/includes/objectcache/BagOStuff.php +++ b/includes/objectcache/BagOStuff.php @@ -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) diff --git a/includes/parser/CoreParserFunctions.php b/includes/parser/CoreParserFunctions.php index 403e7a30ab..1710837597 100644 --- a/includes/parser/CoreParserFunctions.php +++ b/includes/parser/CoreParserFunctions.php @@ -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 ) ) diff --git a/includes/search/SearchPostgres.php b/includes/search/SearchPostgres.php index 0e5dc9bad6..b0590d0f69 100644 --- a/includes/search/SearchPostgres.php +++ b/includes/search/SearchPostgres.php @@ -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" ); -- 2.20.1