Documentation?

[Jon Shier]

Devs: Just wondering what progress has been made on the documentation. If it's a wiki, a link to it, even incomplete, would be great. The Pixen code is fairly complex, with quite a few external dependencies and custom classes that don't have an obvious purpose. Plus an overview of the entire app would be great, since I'm not familiar with all the features Pixen offers. For me, just knowing what the intended purpose of various files would be a great help as I try to modernize the application. Jon

[Philippe Casgrain]

Le 2009-10-18 à 17:17, Jon Shier a écrit :

Just wondering what progress has been made on the documentation. If it's a wiki, a link to it, even incomplete, would be great.

There is a wiki:

http://wiki.github.com/philippec/Pixen

Feel free to edit as needed. I personally don't have any documentation though.

If we want to document the classes inside the source code, we should standardize on a format and add it as we go along to the source code. Then we can auto-generate it.

Some people use Doxygen for that. I have some experience doing it with HeaderDoc, which has the advantage of being installed along with Xcode.

Philippe