2008/8/4 Ludovic Dubost <ludovic(a)xwiki.com>om>:
Hi,
I've published in svn a tool based on velocidoc
(
http://sourceforge.net/projects/velocidoc/) to allow to generate javadoc
style documentation for velocity macros.
You'll find links to it and an example of generating for the XWiki Platform
Web templates directory on the wiki:
http://dev.xwiki.org/xwiki/bin/view/Drafts/Documenting+XWiki+Velocity+Macros
From now on we should start documeting velocity macros with the following
syntax:
#**
* Description of the macro
* @param paramname desc
* @param paramname desc
* @author author
*#
A later improvement will allow parsing XWiki xml files and extract
documentation of the pages in the same format.
Great Idea !
We now have to add this to our maven build to generate it for each release.
Ludovic
--
Ludovic Dubost
Blog:
http://blog.ludovic.org/
XWiki:
http://www.xwiki.com
Skype: ldubost GTalk: ldubost
_______________________________________________
devs mailing list
devs(a)xwiki.org
http://lists.xwiki.org/mailman/listinfo/devs
--
Thomas Mortagne