5 Aug
2008
5 Aug
'08
10:27 p.m.
Hi,
It's cool but it looks like you've copied the source of the framework.
It would be much nicer if we could use the jar (haven't researched it
so don't know how easy it is or not).
It also needs some maven integration since I've seen a sh file and it
seems the dependent jars are not downloaded automatically.
Someone would need to spend 1-2 days on it to make it usable,
integrated and clean before we can use it on our projects.
Thanks
-Vincent
On Aug 4, 2008, at 2:12 AM, Ludovic Dubost wrote:
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.
Ludovic