Page MenuHomePhabricator

Parse MediaWiki hook documentation from hook interfaces and upload it to MediaWiki.org
Open, Needs TriagePublic

Description

Hook documentation tends to be outdated. At least the infobox should be kept current automatically. In the long run, this might also allow us to provide versioned documentation.

Event Timeline

Tgr renamed this task from Parse MediaWiki hook documentation from hooks.txt and upload it to MediaWiki.org to Parse MediaWiki hook documentation from hook interfaces and upload it to MediaWiki.org.Dec 19 2022, 12:45 AM

hooks.txt doesn't contain hook documentation anymore; it is in the method documentation of the hook interface files. Which is a bit more tricky as there isn't any machine-readable way to designate a file as a hook interface, although simply using interfaces whose names end with Hook might be close enough. Or maybe parse the return types of HookRunner or HookContainer?

There is also no machine-readable way of designating something as a hook runner in an extension.