[infinispan-dev] JMX documentation

[Vladimir Blagojevic]

Guys,

How do you make these profiles that Manik talks about? I made another 
Doclet and I also want to run it in a similar fashion! Let me know!

Vladimir

On 6/4/09 10:02 AM, Manik Surtani wrote:
> Guys
>
> I have created a module called 'tools' in Infinispan trunk.  This 
> module is not packaged for distribution, but contains internal tools 
> to help with the build and development process.  So far I have created 
> one tool here - a custom Doclet that generates a summary of all JMX 
> components based on the JMX @MBean, @ManagedOperation and 
> @ManagedAttribute annotations.
>
> The Doclet is currently invoked by running mvn install with the 
> -Pjmxdoc profile.  This will eventually be rolled in to the 
> -Pdistribution profile when building the Infinispan distribution.
>
> The output of the Doclet can be viewed here:
>
>     http://infinispan.sourceforge.net/4.0/apidocs/jmxComponents.html
>
> So please make extensive use of the 
> @MBean/@MBeanOperation/@MBeanAttribute name, objectName and 
> description parameters when you use these annotations, to properly 
> describe what it is you are exposing and what it is good for.  These 
> values are used to generate the doc you see above.
>
> Also, there is another JIRA to document a configuration reference 
> [1].  I expect this will take a similar approach, with each setter in 
> Configuration and GlobalConfiguration being annotated with equivalent 
> XML elements, details such as default and allowed values, and a 
> description.
>
> Cheers
> Manik
>
> [1] https://jira.jboss.org/jira/browse/ISPN-89
>
> -- 
> Manik Surtani
> manik at jboss.org
> Lead, Infinispan
> Lead, JBoss Cache
> http://www.infinispan.org
> http://www.jbosscache.org
>
>
>
>
> _______________________________________________
> infinispan-dev mailing list
> infinispan-dev at lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/infinispan-dev