[ka-Map-users] API documentation

[Paul Spencer]

All,

I've decided on using jsdoc (jsdoc.sourceforge.net) to generate API  
documentation for ka-Map.  I've committed an initial version of the  
docs in the docs directory in cvs.

To generate documentation yourself, you will need jsdoc from the site  
above, perl, and HTML::Template (see jsdoc instructions).  Then you  
can run jsdoc on the javascript files to generate the documentation.

I've included a target in the Makefile for those of you on *nix  
systems (mac/linux) so you can just type

make jsdoc

if jsdoc is installed in ../jsdoc

Alternately you can run it at the command line (on any platform) with:

perl ../jsdoc/jsdoc.pl -d docs --project-name ka-Map \
                  ./htdocs/DHTMLapi.js \
	         ./htdocs/kaKeymap.js \
	         ./htdocs/kaLegend.js \
	         ./htdocs/kaMap.js \
	         ./htdocs/kaQuery.js \
	         ./htdocs/kaScalebar.js \
	         ./htdocs/kaTool.js \
	         ./htdocs/kaZoomer.js \
	         ./htdocs/scalebar/scalebar.js \
	         ./htdocs/wmsLayer.js \
	         ./htdocs/xhr.js \
	         ./htdocs/XMLOverlay/kaOverlay.js \
	         ./htdocs/XMLOverlay/kaXmlOverlay.js \
	         ./htdocs/XMLOverlay/overlayLayer.js

I've committed a new version of kaTool.js that has updated comments  
per the jsdoc style and it seems to work quite nicely.  I plan to go  
through most of the rest of the js files to update the docs to this  
style of docs as well.  Some help from the other contributors would  
be welcome, especially for the files that they control.

Cheers

Paul

+-----------------------------------------------------------------+
|Paul Spencer                           pspencer at dmsolutions.ca   |
+-----------------------------------------------------------------+
|Applications & Software Development                              |
|DM Solutions Group Inc                 http://www.dmsolutions.ca/|
+-----------------------------------------------------------------+