Robert Burrell Donkin ha scritto:
On Fri, Aug 22, 2008 at 9:04 PM, Stefano Bagnara <[EMAIL PROTECTED]> wrote:
[...]
I created a very simple Mojo (attached to MAILET-14) that scan all of the
java files in a maven project and if they implements Mailet or Matcher take
them, their "getMailetInfo"/"getMatcherInfo" return value (yes, it
instantiate them too) and the class javadoc and put all of this in an xdoc
report that will be automatically generated during the maven site
generation.
[...]
cool :-)
I gave it only a couple of hours, so there is a lot to do yet.. any
suggestion is welcome.
a couple of easy starters:
1. sort alphabetically
2. add an index for the page
Done, and generate:
http://svn.apache.org/repos/asf/james/site/trunk/www/mailet/standard/mailet-report.html
cool but a little more involved
3. support faceted classification (this would mean adding a category taglet)
Let's first add the category.. when they will be categorized I'll add
category support to the plugin.
cool toys but would require work
4. semantic export
5. mailet composite indexer (using semantic exports)
Cool, but too much for me now. I have too many todos with higher
priorities that I can't even add this to the end of the list ;-)
I think this approach is very good, expecially if we define some new taglet
and we start documenting mailets using some specific taglet (e.g: for
parameters) so to be able to better document their usage.
+1
All a project have todo to automatically create a similar report for the
mailets included in the product is add this to the pom's <reporting>
configuration:
<plugin>
<groupId>org.apache.james</groupId>
<artifactId>maven-mailetdocs-plugin</artifactId>
</plugin>
great
let's think of a good name and get it committed into the mailets subproject
I added it as maven-mailetdocs-plugin.
If you have any better suggestion we can easily rename it.
Stefano
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
