docs: Add support for @inheritDoc (alias for @inheritdoc)
authorTimo Tijhof <krinklemail@gmail.com>
Thu, 5 Sep 2019 15:22:16 +0000 (16:22 +0100)
committerTimo Tijhof <krinklemail@gmail.com>
Thu, 5 Sep 2019 15:27:45 +0000 (16:27 +0100)
Lots of methods are missing documentation for methods in favour
of an unhelpful description text containing "@inheritDocs", leading
to warnings in CI during the doc building stage:

> mediawiki/includes/resourceloader/ResourceLoaderLessVarFileModule.php:9:
> warning: Found unknown command '\inheritDoc'

Before:

> ◆ ResourceLoaderLessVarFileModule::getMessages ( )
> Description
>   @inheritDoc
>
> Reimplemented from ResourceLoaderFileModule.
> Definition at line 26 of file ResourceLoaderLessVarFileModule.php.

After:

> ◆ ResourceLoaderLessVarFileModule::getMessages ( )
> Description
>   Gets list of message keys used by this module.
>
> Returns
>   array List of message keys
>
> Reimplemented from ResourceLoaderFileModule.
> Definition at line 26 of file ResourceLoaderLessVarFileModule.php.

Bug: T219001
Bug: T232104
Change-Id: I7f133c10acca084239a158c63c08b71e709404c3

maintenance/Doxyfile

index e5a8d98..d52f232 100644 (file)
@@ -55,6 +55,7 @@ ALIASES                = "type{1}=<b> \1 </b>:" \
                          "protected=\access protected" \
                          "copyright=\note" \
                          "license=\note" \
+                         "inheritDoc=\inheritdoc" \
                          "codeCoverageIgnore=" \
                          "codingStandardsIgnoreStart=" \
                          "group=" \