4:11 p.m.
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
8:06 p.m.
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(a)lists.jboss.org
https://lists.jboss.org/mailman/listinfo/infinispan-dev
--
Manik Surtani
manik(a)jboss.org
Lead, Infinispan
Lead, JBoss Cache
http://www.infinispan.org
http://www.jbosscache.org
9:50 a.m.
Ok, I'll do this but if I hit a maven wall I call the cavalry !
On 7/6/09 8:06 PM, Manik Surtani wrote:
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
11:42 a.m.
On 7 Jul 2009, at 08:50, Vladimir Blagojevic wrote:
Ok, I'll do this but if I hit a maven wall I call the cavalry !
:-) We're all here to help!
On 7/6/09 8:06 PM, Manik Surtani wrote:
> 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
>
--
Manik Surtani
manik(a)jboss.org
Lead, Infinispan
Lead, JBoss Cache
http://www.infinispan.org
http://www.jbosscache.org
8:16 p.m.
Quick q's about the annotations - so you place ConfigurationElement(s)
annotations on classes and ConfigurationAttribute annotations on
setters? Or can the latter be on fields as well? And what about
object hierarchy, e.g., if I have an abstract class with
ConfigurationElement defined and subclasses with
ConfigurationAttributes?
Also, some Javadocs on these annotations - preferably with a usage
example - will help people use them as we move forward. At the end of
the day we want people to document configuration this way, and should
make it as easy as possible to do. :-)
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(a)lists.jboss.org
https://lists.jboss.org/mailman/listinfo/infinispan-dev
--
Manik Surtani
manik(a)jboss.org
Lead, Infinispan
Lead, JBoss Cache
http://www.infinispan.org
http://www.jbosscache.org
9:48 a.m.
Yeah, something like that. I will provide all the details as soon as I
have xml conf reading done. There might be some slight changes to
accommodate xsd schema creation, if needed. Of course, javadocs will be
there as well.
On 7/6/09 8:16 PM, Manik Surtani wrote:
Quick q's about the annotations - so you place
ConfigurationElement(s)
annotations on classes and ConfigurationAttribute annotations on
setters? Or can the latter be on fields as well? And what about
object hierarchy, e.g., if I have an abstract class with
ConfigurationElement defined and subclasses with ConfigurationAttributes?
Also, some Javadocs on these annotations - preferably with a usage
example - will help people use them as we move forward. At the end of
the day we want people to document configuration this way, and should
make it as easy as possible to do. :-)
Cheers
Manik
5414
days inactive
5428
days old
infinispan-dev@lists.jboss.org
5 comments
2 participants
participants (2)
-
Manik Surtani -
Vladimir Blagojevic