Hello,

Since we introduced hooks in MediaWiki, the documentation has been
maintained in a flat file /docs/hooks.txt . Over the week-end I have
converted the content of that file to let Doxygen recognize it.

The patchset is:
  https://gerrit.wikimedia.org/r/#/c/66128/

I have used that patch to generate a temporary documentation.  That lets
everyone browse the result easily.  The produced result is:

A landing page:
 https://doc.wikimedia.org/mw-hooks/hooks_mainpage.html

The doc overview:
 https://doc.wikimedia.org/mw-hooks/page_hooks_documentation.html

A list of hooks with their documentation:
 https://doc.wikimedia.org/mw-hooks/page_hooks_list.html


I think that makes it a bit more accessible to everyone and Doxygen
autolink to referenced classes.

Some issues I have:

 - the hooks are listed alphabetically when they could be regrouped by
theme (like API, SpecialPages, HTML Forms ...).

 - The hooks are documented in a separate file (still docs/hooks.txt),
when we might want to have the doc near the wfRunHooks() call.

Thoughts ?

-- 
Antoine "hashar" Musso


_______________________________________________
Wikitech-l mailing list
Wikitech-l@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/wikitech-l

Reply via email to