4 Aug
2008
4 Aug
'08
11:07 a.m.
I'm not sure there is a such thing as public/non public.
However we can tell which one we support in the API.
Ludovic
vincent(a)massol.net wrote:
yes and we need to separate public velocimacros from
non public ones
-Vincent
On 8/4/08, Ludovic Dubost <ludovic(a)xwiki.com> wrote:
--
Ludovic Dubost
Blog: http://blog.ludovic.org/
XWiki: http://www.xwiki.com
Skype: ldubost GTalk: ldubost
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
_______________________________________________
devs mailing list
devs(a)xwiki.org
http://lists.xwiki.org/mailman/listinfo/devs