WarpShare™

Tarzan website updated with all-new documentation

Most of my last month has been spent creating the new Tarzan website (which just launched a few weeks ago), and completely revamping the all-new online API reference. Now, although having online documentation isn’t new for this project, having it be (a) complete, and (b) match with the rest of the site was quite a bit of work.

To generate the documentation directly from source code comments, I chose to use (a heavily customized version of) NaturalDocs 1.4. My number one, biggest problem with source code documentation systems is the inability to easily edit the output HTML. I’ve used PHPDocumentor, phpDoc, and Doxygen in the past, and although the CSS editing is fairly straightforward, I prefer to fine-tune my markup before I publish it. Although I still can’t say that it’s easy to edit (fix) the (crappy) HTML that these documentation systems offer, NaturalDocs was the easiest of the bunch.

I, personally, find the new docs easier to read, follow, and link to. Hopefully you will also find them equally as useful. Let us know what you think! Fire away in the comments!

Categories: Tarzan

Leave a comment

Name (required)

Mail (will not be published) (required)

Website