API Documentation

[springmeyer]

Its time for good API documentation. Will plan to start something in the style of node-sqlite3.

[springmeyer]

started to rough out at https://github.com/mapnik/node-mapnik/wiki/API

[clns]

Hi @springmeyer I created a TypeScript definition for node-mapnik. It currently has all the main classes, but there is more work to be done, and in some places there may be better explanations as I did all this by looking at the source code and tests.

I know there is the API page which you said I could add to, but I wanted to also have intellisense in IDEs. I plan to improve it in the following days, and I will also push it in the DefinitelyTyped repo once it'll met all the requirements.

I'd love to hear your thoughts on this, and if you feel we could somehow add it in the API page (not sure how at the moment).

[springmeyer]

Looks like a good start. Maybe since what you need is slightly more involved that just a wiki page you could simply add a link to your work on the wiki for now. We could consider writing a script to auto-convert to markdown format for the wiki.

[springmeyer]

closing this is on its way at https://github.com/mapnik/node-mapnik/wiki/API