On Fri, Aug 22, 2008 at 9:04 PM, Stefano Bagnara <[EMAIL PROTECTED]> wrote: > Robert Burrell Donkin ha scritto: >> >> i've committed a revised version of the mailet site based on the new >> division into products. should appear on >> http://james.apache.org/mailet/ once the servers have sync'd. it's >> still pretty basic and feedback appreciated or even better, dive in >> and patch. the easiest way to edit the site is to check out >> http://svn.apache.org/repos/asf/james/mailet/current/ (it might look a >> little empty but the products are linked by externals). the main site >> is found in src/site and the subsite for each product in the src/site >> directory of the product subdirectory (for example, api/src/site). >> >> IMHO improving website content is the major task which needs to be >> completed before API and crypto can be released. since we're on a >> release roll, now seems a good time to start :-) > > I'm not good at documentation, but I think I've found a task for me. > It was at least an year I wanted to write some maven plugin to understand > how difficult they are, so I decided this time was the right time. > > 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. > > I didn't know if you will like this idea, so I simply compiled the plugin > locally and temporarily added it only to mailet-standard product so to be > able to produce a result on people.a.o and let you see it. > > If you like it then we'll probably should put the maven plugin as a sister > project for the mailet products. > > Here you can see the resulting report of the current "raw" code. > http://people.apache.org/~bago/mailet/standard/site/mailet-report.html
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 cool but a little more involved 3. support faceted classification (this would mean adding a category taglet) cool toys but would require work 4. semantic export 5. mailet composite indexer (using semantic exports) > 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 - robert --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
