pithy title here

2004-3-7

HeaderDoc

This weekend I went through the (light) effort to start documenting all the SCPlugin code. I think that this is a worthwhile goal; if you can't document the code that you are writing, you probably don't understand it.

I am doing all the documentation with HeaderDoc. It consists of two perl scripts and a config file. The HeaderDoc format itself is easy enough to use, and generates decent enough HTML. It would be cool to get linking to work between Classes, the way Apple's documentation online works. For now though, it is a decent solution.

If you are interested in checking out the docs, they are part of the Subversion source tree now. I intend to keep these up to date with every commit going forward.

----

Cool note: In tonight's episode of The Soprano's Anthony Jr was sporting an ipod.

Comment on this post [ so far] ... more like this: [SCPlugin]