diff options
author | Timo Tijhof <krinkle@fastmail.com> | 2024-03-13 12:39:49 -0700 |
---|---|---|
committer | Timo Tijhof <krinkle@fastmail.com> | 2024-03-13 12:46:08 -0700 |
commit | 8360322b04255cd85b5cc57a048fc5f725d82879 (patch) | |
tree | f7583c01c38a1fa6887216c069df6eec1d502552 /includes/libs/mime/MimeAnalyzer.php | |
parent | 3fabbf33b454d43cc0839400607b75a59f2ac4db (diff) | |
download | mediawikicore-8360322b04255cd85b5cc57a048fc5f725d82879.tar.gz mediawikicore-8360322b04255cd85b5cc57a048fc5f725d82879.zip |
mime: Improve docs, add ingroup tags to class doc blocks
* Remove redundant file-level description and ensure the class desc
and ingroup tag are on the class block instead.
Ref https://gerrit.wikimedia.org/r/q/owner:Krinkle+message:ingroup
Also remove `@group` from `@file` block in MediaHandler.php,
which caused an unhelpful duplicate to be shown in the navigation
on doc.wikimedia.org.
* Create a new "Mime" doc group, and tag all wikimedia/mime classes
with it. Organize it as a subgroup of "Media", matching the way
its tests and other classes relating to handling of media uploads.
* Remove dependency on wikimedia/at-ease per T253461.
Change-Id: If7629db2f33ba8059c5d58d2992488f8f49be373
Diffstat (limited to 'includes/libs/mime/MimeAnalyzer.php')
-rw-r--r-- | includes/libs/mime/MimeAnalyzer.php | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/includes/libs/mime/MimeAnalyzer.php b/includes/libs/mime/MimeAnalyzer.php index 8d27ce34e7a4..72855cf54bd0 100644 --- a/includes/libs/mime/MimeAnalyzer.php +++ b/includes/libs/mime/MimeAnalyzer.php @@ -1,7 +1,5 @@ <?php /** - * Module defining helper functions for detecting and dealing with MIME types. - * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or @@ -27,9 +25,16 @@ use Wikimedia\Mime\MimeMap; use Wikimedia\Mime\MimeMapMinimal; /** - * Implements functions related to MIME types such as detection and mapping to file extension + * @defgroup Mime Mime + * + * @ingroup Media + */ + +/** + * Detect MIME types of a file by mapping file extensions or parsing file contents. * * @since 1.28 + * @ingroup Mime */ class MimeAnalyzer implements LoggerAwareInterface { /** @var string */ |