It's probably possible though it's a bit tricky when you don't know javacc et jjtree well.. I've added getting the code of the macro itself in the process of which I understood only half of what I've been doing.
I've added support of getting XWiki pages (from the file system). This should allow to document macros in pages as well as the pages themselves. What would be even more valuable would be : - to be able to read a live wiki - to be able to read usages of macros to have a cross reference This is more work and I don't have enough time for this at this point. If anybody wants to play with it, go ahead. Ludovic Jerome Velociter 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 > > 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 > > -- 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
