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

--
Ludovic Dubost
Blog: http://blog.ludovic.org/
XWiki: http://www.xwiki.com
Skype: ldubost GTalk: ldubost

begin:vcard
fn:Ludovic Dubost
n:Dubost;Ludovic
org:XWiki
adr:;;10 Rue Pernety;Paris;;75014;France
email;internet:[EMAIL PROTECTED]
title:CEO
tel;work:01 45 42 40 90
tel;fax:09 59 26 92 14
tel;home:09 54 26 92 14
tel;cell:06 09 34 92 14
x-mozilla-html:TRUE
url:http://www.xwiki.com
version:2.1
end:vcard

_______________________________________________
devs mailing list
[email protected]
http://lists.xwiki.org/mailman/listinfo/devs

Reply via email to