Quick Links: Download Gideros Studio | Gideros Documentation | Gideros community chat | DONATE
Generated 'Gideros API Reference Manual' — Gideros Forum

Generated 'Gideros API Reference Manual'

I'm working on a Gideros API manual that's completely generated by the existing API documentation. Hopefully this will allow us to see more easily what's missing and if any corrections need to be made. Because it's generated from the data as the data gets updated I can just run the script to make a new version of the manual.

Currently it's missing two things, a html parser to properly format descriptions and a syntax highlighter to colour the examples.

Here it is so far:
https://www.dropbox.com/s/62dtqjtfqsbl2y3/GiderosApi.pdf?dl=0

If you find anything wrong or missing (compared to the online API docs) then please let me know. Don't forget the descriptions might look a little odd because of no formatting and the listings are not yet in colour!

The plan is to have the pdf available as a free download, if possible a free e-book on Amazon and as a paid for paper book on Amazon or Lulu - which ever is the cheaper for people to buy. The paper version hopefully will be available in either b/w or colour.

Likes: antix, Apollo14, oleg

Coder, video game industry veteran (since the '80s, ❤'s assembler), arrested - never convicted hacker (in the '90s), dad of five, he/him (if that even matters!).
https://deluxepixel.com
+1 -1 (+3 / -0 )Share on Facebook

Comments

Sign In or Register to comment.