On 8/4/08, Jerome Velociter <[email protected]> wrote:
Agreed, this is very valuable tool!
For the public/private visibility, we can try to find out if there is some mean to easily add a new annotation, like @public
I meant something simpler like moving non public apis in another vm file. Right now we only have one macros.vm file.
Jerome.
Pascal Voitot wrote:
I was exactly thinking about something like that yesterday ;)
great!!!
Pascal
On Mon, Aug 4, 2008 at 11:07 AM, Ludovic Dubost <[email protected]> wrote:
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
[email protected] wrote:
yes and we need to separate public velocimacros from non public ones
-Vincent
On 8/4/08, Ludovic Dubost <[email protected]> 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
-- Ludovic Dubost Blog: http://blog.ludovic.org/ XWiki: http://www.xwiki.com Skype: ldubost GTalk: ldubost
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Ludovic Dubost Blog: http://blog.ludovic.org/ XWiki: http://www.xwiki.com Skype: ldubost GTalk: ldubost
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs