Page MenuHomePhabricator

Doxygen improvements to support hook interfaces
Closed, ResolvedPublic

Description

Background

In the new hook system based on HookContainer, hooks are defined in individual interfaces, such as BeforeHttpsRedirectHook.php. To organize these hooks, each interface includes an @ingroup Hooks tag.
In Doxygen, these group tags are designed to produce a dedicated page within the Modules section. For example, the Maintenance group. However, in order for the module page to be generated, a @defgroup tag must be included in a file with @ingroup Hooks to define the group. (See Doxygen docs.) For example, the Maintenance group is defined in Maintenance.php.

To do

  • Following the pattern set by Maintenance.php, add @defgroup Hooks Hooks and @ingroup Hooks tags to a top-level Hook file (HookContainer or HookRunner?) to enable the Hooks group
    • Output in Doxygen:
      Screen Shot 2020-05-27 at 4.46.49 PM.png (592×914 px, 99 KB)
      Screen Shot 2020-05-27 at 4.47.03 PM.png (435×916 px, 68 KB)
  • Add an alias to the Doxyfile to support @stable tags
    • Output in Doxygen:
      Screen Shot 2020-05-27 at 2.52.20 PM.png (270×816 px, 34 KB)

Event Timeline

Change 599134 had a related patch set uploaded (by Alex Paskulin; owner: Alex Paskulin):
[mediawiki/core@master] docs: Add Doxygen alias for stable tag

https://gerrit.wikimedia.org/r/599134

Change 599142 had a related patch set uploaded (by Alex Paskulin; owner: Alex Paskulin):
[mediawiki/core@master] docs: Add Hooks defgroup tag

https://gerrit.wikimedia.org/r/599142

Change 599142 merged by jenkins-bot:
[mediawiki/core@master] docs: Add Hooks defgroup tag

https://gerrit.wikimedia.org/r/599142

Change 599134 merged by jenkins-bot:
[mediawiki/core@master] docs: Add Doxygen alias for stable tag

https://gerrit.wikimedia.org/r/599134