Looks pretty nice. My only complaint is that on the list page the hook header text is the same font size and weight as the "Parameters" header. I know it's indented, so you can sort of tell, but for ease of use purposes I think we should somehow change that.
- The hooks are documented in a separate file (still docs/hooks.txt), > when we might want to have the doc near the wfRunHooks() call. This would be nice, but it'd have to be possible first. Not sure if Doxygen can even do that. Besides, it'd also mean the maintenance script would have to scan every file rather than just a doc/hooks.txt file. *-- * *Tyler Romeo* Stevens Institute of Technology, Class of 2016 Major in Computer Science www.whizkidztech.com | tylerro...@gmail.com On Tue, Jun 4, 2013 at 12:00 PM, Antoine Musso <hashar+...@free.fr> wrote: > 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 _______________________________________________ Wikitech-l mailing list Wikitech-l@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/wikitech-l
