From 3517d951ba947be388f8468f43d3092e22d39a2a Mon Sep 17 00:00:00 2001 From: Roan Kattouw Date: Wed, 20 Oct 2010 14:58:35 +0000 Subject: [PATCH] Some comment fixes: be consistent between # and //, fix grammar, remove information about internals from Doxygen comment (those are about what the function does, not how). Also make $modules argument to makeModuleResponse() default to array() instead of null --- includes/resourceloader/ResourceLoader.php | 14 ++++++-------- includes/resourceloader/ResourceLoaderContext.php | 4 ++-- 2 files changed, 8 insertions(+), 10 deletions(-) diff --git a/includes/resourceloader/ResourceLoader.php b/includes/resourceloader/ResourceLoader.php index d75d573237..2c815fe27e 100644 --- a/includes/resourceloader/ResourceLoader.php +++ b/includes/resourceloader/ResourceLoader.php @@ -43,11 +43,9 @@ class ResourceLoader { * This method grabs modules dependencies from the database and updates modules objects. * * This is not inside the module code because it's so much more performant to request all of the information at once - * than it is to have each module requests it's own information. This sacrifice of modularity yields a profound + * than it is to have each module requests its own information. This sacrifice of modularity yields a profound * performance improvement. * - * A first pass calculates dependent file modified times, a second one calculates message blob modified times. - * * @param {array} $modules List of module names to preload information for * @param {ResourceLoaderContext} $context Context to load the information within */ @@ -66,7 +64,7 @@ class ResourceLoader { ), __METHOD__ ); - // Set modules dependecies + // Set modules' dependecies $modulesWithDeps = array(); foreach ( $res as $row ) { $this->modules[$row->md_module]->setFileDependencies( $skin, @@ -108,12 +106,12 @@ class ResourceLoader { /** * Runs JavaScript or CSS data through a filter, caching the filtered result for future calls. * - * Availables filters are: + * Available filters are: * - minify-js \see JSMin::minify * - minify-css \see CSSMin::minify * - flip-css \see CSSJanus::transform * - * If data is empty, only whitespace or the filter was unknown, data is returned unmodified. + * If $data is empty, only contains whitespace or the filter was unknown, $data is returned unmodified. * * @param {string} $filter Name of filter to run * @param {string} $data Text to filter, such as JavaScript or CSS text @@ -327,10 +325,10 @@ class ResourceLoader { * * @param {ResourceLoaderContext} $context Context in which to generate a response * @param {array} $modules List of module objects keyed by module name - * @param {array} $missing List of unavailables modules (optional) + * @param {array} $missing List of unavailable modules (optional) * @return {string} Response data */ - public function makeModuleResponse( ResourceLoaderContext $context, array $modules, $missing = null ) { + public function makeModuleResponse( ResourceLoaderContext $context, array $modules, $missing = array() ) { // Pre-fetch blobs $blobs = $context->shouldIncludeMessages() ? MessageBlobStore::get( $this, $modules, $context->getLanguage() ) : array(); diff --git a/includes/resourceloader/ResourceLoaderContext.php b/includes/resourceloader/ResourceLoaderContext.php index a053ff52b1..594d4c07b5 100644 --- a/includes/resourceloader/ResourceLoaderContext.php +++ b/includes/resourceloader/ResourceLoaderContext.php @@ -51,10 +51,10 @@ class ResourceLoaderContext { $this->request = $request; // Interpret request - # list of modules + // List of modules $modules = $request->getVal( 'modules' ); $this->modules = $modules ? explode( '|', $modules ) : array(); - # various parameters + // Various parameters $this->language = $request->getVal( 'lang' ); $this->direction = $request->getVal( 'dir' ); $this->skin = $request->getVal( 'skin' ); -- 2.20.1