SwellJS - another big fish in the sea » JSDoc http://blog.justswell.org well-minded javascript library Fri, 20 Aug 2010 20:48:04 +0000 en hourly 1 http://wordpress.org/?v=3.0.4 SVN post-commit hook, API doc autogeneration http://blog.justswell.org/svn-post-commit-hook-api-doc-autogeneration/ http://blog.justswell.org/svn-post-commit-hook-api-doc-autogeneration/#comments Thu, 05 Mar 2009 13:17:35 +0000 http://blog.justswell.org/?p=22 Generating manually Swell’s API doc actually’s being a pain, we finally chose to generate it automatically through subversion’s repositories hooks.
These hooks once enabled, allows you to listen specific SVN-based events (pre/start/post commit/lock…) and therefore execute your home-made script.

In our case, we use JSDoc to generate the API doc and well, it took about 6mins with one core (2ghz) fully-loaded to parse/generate the documentation for only 4 files…
Let’s hope that we’ll not commit too often.

svn up /path/to/your/repository/api/src
java -jar /path/to/your/repository/api/jsdoc/jsrun.jar /path/to/your/repository/api/jsdoc/app/run.js -r=1 /path/to/your/repository/api/src -t=/path/to/your/repository/api/jsdoc/templates/jsdoc
]]> http://blog.justswell.org/svn-post-commit-hook-api-doc-autogeneration/feed/ 0