[infinispan-dev] Document all configuration options available in XML

[Manik Surtani]

The reason why it makes sense as a formal Javadoc Doclet is that tools  
that support Javadoc will also support this Doclet.  E.g., Maven's  
document generation plugins.

Regarding classpaths, this is a simple workaround - make sure the doc  
generation is done by the aggregate pom in the project root.  This  
way, all dependent modules are automagically generated and added to  
the classpath before the javadoc plugin is executed.

Your best bet would be to have a look at the jmxdoc profile I have in  
the root pom.xml, and copy this out to your own configdoc profile in  
the same pom.

I have a shell script in bin/generateJmxDocs.sh which runs maven with  
the necessary switches to enable the necessary profiles.  A similar  
bin/generateConfigDocs.sh script would do the trick for you.  :-)

Cheers
Manik

On 23 Jun 2009, at 15:11, Vladimir Blagojevic wrote:

> Hi,
>
> I finished up https://jira.jboss.org/jira/browse/ISPN-89 today. I  
> decorated only a few bean configuration classes. I want to get a nod  
> from Manik first before proceeding further on this front. I also  
> committed a ConfigDoclet in tools project. ConfigDoclet is supposed  
> to create configuration documentation in html. However, I could not  
> figure out how to include ConfigDoclet invocation into maven.  
> ConfigDoclet requires -classpath flag to include all jars from  
> dependent projects. If you are maven proficient and have a lot of  
> hair please be my guest :) For testing purposes I was invoking  
> ConfigDoclet as a simple java class with main method. We can invoke  
> this doclet as a simple java program. No need for this doclet  
> nonsense.
>
> Regards,
> Vladimir
> _______________________________________________
> infinispan-dev mailing list
> infinispan-dev at lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/infinispan-dev

--
Manik Surtani
manik at jboss.org
Lead, Infinispan
Lead, JBoss Cache
http://www.infinispan.org
http://www.jbosscache.org