I'm pretty happy with the outcome. Per Rave-984 [1], I've completed the docs for the rave core modules. Given the angular rewrite and the inscrutable nature of the portal code I'm not planning to document those modules at this time. I opened another issue [2] for integrating documentation generation into the build process for releases.
[1] https://issues.apache.org/jira/browse/RAVE-984 [2] https://issues.apache.org/jira/browse/RAVE-989 On Sun, Jul 21, 2013 at 9:48 PM, Matt Franklin <[email protected]> wrote: > On Wed, Jul 17, 2013 at 12:13 PM, Erin Noe-Payne > <[email protected]>wrote: > >> For anyone interested, I have added the jsdoc3 plugin to >> rave-portal-resources and documented exactly one of the core modules >> using jsdoc3. You can see the output by runing "$ mvn jsdoc3:jsdoc3" >> from rave-portal-resources. The site is built to >> ./target/site/jsdoc/module-rave.html. >> >> This is tied to the "$ mvn site" goal, but at the moment that is >> throwing some erros that I have not tried to debug yet. >> >> I'll be moving forward with documenting the rest of the core js >> modules. Give a shout if you have any input about the docs or thoughts >> about how to version and upload documentation to the rave site as part >> of our release or build process. >> >> > Awesome! > > >> On Wed, Jun 19, 2013 at 4:41 PM, Matt Franklin <[email protected]> >> wrote: >> > On Wed, Jun 19, 2013 at 10:35 AM, Erin Noe-Payne >> > <[email protected]>wrote: >> > >> >> 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. >>
