rave-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Matt Franklin <m.ben.frank...@gmail.com>
Subject Re: Auto-generated docs
Date Wed, 19 Jun 2013 20:41:35 GMT
On Wed, Jun 19, 2013 at 10:35 AM, Erin Noe-Payne

> Hey All,
> As I continue to work on rave's javascript, I would like to integrate
> a comment-based auto-generated documentation tool into the build
> process. Right now I am looking at the JSDoc maven plugin
> (https://github.com/phasebash/jsdoc3-maven-plugin).
+1 for the concept.  I have no specific experience with jsdoc, but if it
fits our needs, it sounds good to me.

> I'm curious...
> 1) If anyone has an opinion about this or any other tool.
> 2) Is there a way to integrate the generated docs with the
> rave.apache.org site, to make api docs available associated with each
> release.

There is a maven site plugin.  We should be doing the same thing for the
javadocs as well.

  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message