[ka-Map-dev] [Bug 1362] New: create useful API documentation

bugzilla-daemon at bugzilla.maptools.org bugzilla-daemon at bugzilla.maptools.org
Wed Mar 15 10:55:34 EST 2006


           Summary: create useful API documentation
           Product: ka-Map
           Version: 0.2
          Platform: Macintosh
        OS/Version: All
            Status: NEW
          Severity: enhancement
          Priority: P3
         Component: documentation
        AssignedTo: ka-map-dev at lists.maptools.org
        ReportedBy: pspencer at dmsolutions.ca

I've decided on using jsdoc (jsdoc.sourceforge.net) to generate API documentation for kaMap.  Initial 
commit to cvs will include a target in the Makefile for generating the documentation into the docs 
directory and an initial commit of the generated docs.

I'll also commit kaTool.js which was my initial test case for documentation.  It'll take a while to propogate 
the documentation to the whole API but at least this is a start.

------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.

Please do NOT reply to this email, use the link above instead to 
login to bugzilla and submit your comment. Any email reply to this
address will be lost.

More information about the ka-Map-dev mailing list