From a5ce1d779274c4999a71bb422cbbd02c8d0d57fe Mon Sep 17 00:00:00 2001 From: Timo Tijhof Date: Sat, 14 Sep 2019 05:32:54 +0100 Subject: [PATCH] resourceloader: Add Doxygen group and improve overall docs * Add license header where missing. * Add missing `@since` (1.17 for most classes), except ResourceLoaderLessVarFileModule since 1.32 (1bc62c548c). * Remove duplicate file-level description for class-only files, merge with the class description instead. * Remove my own `@author` annotation from one file. * Mark core's own FileModule subclasses as `@internal`, except for the following which we support use of in extensions: ResourceLoaderLessVarFileModule, ResourceLoaderOOUIIconPackModule, and ResourceLoaderWikiModule. Change-Id: I336af2e4ccdbe2512594e8861b72628d24194e41 --- .../DerivativeResourceLoaderContext.php | 7 +++--- includes/resourceloader/MessageBlobStore.php | 9 +++++--- includes/resourceloader/ResourceLoader.php | 18 ++++++++++----- .../ResourceLoaderCircularDependencyError.php | 2 +- .../ResourceLoaderClientHtml.php | 1 + .../resourceloader/ResourceLoaderContext.php | 9 ++++---- .../ResourceLoaderFileModule.php | 7 +++--- .../resourceloader/ResourceLoaderFilePath.php | 6 ++--- .../ResourceLoaderForeignApiModule.php | 9 ++++---- .../resourceloader/ResourceLoaderImage.php | 3 +-- .../ResourceLoaderImageModule.php | 5 ++-- .../ResourceLoaderLanguageDataModule.php | 5 +++- .../ResourceLoaderLessVarFileModule.php | 23 ++++++++++++++++++- .../resourceloader/ResourceLoaderModule.php | 5 ++-- .../ResourceLoaderOOUIFileModule.php | 5 ++-- .../ResourceLoaderOOUIIconPackModule.php | 1 + .../ResourceLoaderOOUIModule.php | 3 ++- .../ResourceLoaderSiteModule.php | 7 +++--- .../ResourceLoaderSiteStylesModule.php | 7 +++--- .../ResourceLoaderSkinModule.php | 5 +++- .../ResourceLoaderStartUpModule.php | 3 +++ .../ResourceLoaderUserDefaultsModule.php | 5 ++-- .../ResourceLoaderUserModule.php | 5 +++- .../ResourceLoaderUserOptionsModule.php | 7 +++--- .../ResourceLoaderUserStylesModule.php | 5 +++- .../ResourceLoaderUserTokensModule.php | 8 +++---- .../ResourceLoaderWikiModule.php | 5 ++-- 27 files changed, 116 insertions(+), 59 deletions(-) diff --git a/includes/resourceloader/DerivativeResourceLoaderContext.php b/includes/resourceloader/DerivativeResourceLoaderContext.php index d84a92a914..0a1d5f7789 100644 --- a/includes/resourceloader/DerivativeResourceLoaderContext.php +++ b/includes/resourceloader/DerivativeResourceLoaderContext.php @@ -1,7 +1,5 @@ . + */ + +/** + * ResourceLoader is a loading system for JavaScript and CSS resources. + * + * For higher level documentation, see . * - * Most of the documentation is on the MediaWiki documentation wiki starting at: - * https://www.mediawiki.org/wiki/ResourceLoader + * @ingroup ResourceLoader + * @since 1.17 */ class ResourceLoader implements LoggerAwareInterface { - /** @var Config $config */ + /** @var Config */ protected $config; /** @var MessageBlobStore */ protected $blobStore; diff --git a/includes/resourceloader/ResourceLoaderCircularDependencyError.php b/includes/resourceloader/ResourceLoaderCircularDependencyError.php index 7cd53fe126..5a62861963 100644 --- a/includes/resourceloader/ResourceLoaderCircularDependencyError.php +++ b/includes/resourceloader/ResourceLoaderCircularDependencyError.php @@ -1,6 +1,5 @@