[haiku-doc] Finishing the Support Kit

From: "Niels Reedijk" <niels.reedijk@xxxxxxxxx>
To: haiku-doc@xxxxxxxxxxxxx
Date: Fri, 13 Apr 2007 15:40:14 +0200

Hi guys,

This weekend I´ll try to finish up my documentation for the support
kit. Basically, what needs to be done is to finish documenting some
headers (TypeConstants.h, Errors.h) and the BArchivable class. I might
write the article on archiving and unarchiving, though it´s not my
main priority.

I´ll also make sure that all the files comply with the first two main
sections of the API Documentation guidelines. I suggest that after
that we start discussing the third part (the less technical part) on
writing help. Especially I want to focus on:
- class descriptions
- use of examples
- documenting overloaded methods clearly

I hope you have time to re-read the API guidelines. Now´s also the
time to add comments, by the way.

Anyway, I don´t think I´ll be able to come online this weekend, since
university is closed. I´ll check back in first thing on monday.

Niels

[haiku-doc] Finishing the Support Kit

Other related posts: