12 December, 2006

Tapioca API document (finally)

Until now all the serious documentation we had on Tapioca API was that classs diagram.

Now I have managed to do a proper API document (HTML and PDF versions) for it, which will serve as reference for all Tapioca implementations (C/Glib, Qt, C#). It's DocBook generated from AsciiDoc, which allowed me to escape the burden of writing DocBook directly.

At first I was inclined (in fact, almost decided) to write in DocBook, but every single colleague I asked for advice told me horrible and painful stories about writing DocBook documents. One of them highly recommended AsciiDoc and I decided to give it a try. I'm really liking it so far, its tangoish default stylesheet is being very helpful.