[Adium-devl] Adium documentation

[Peter Hosey]

On Mar 17, 2007, at 17:19:12, Colin Barrett wrote:
> Usually documentation is put in header files because the  
> implementation will be closed-source.

Usually the documentation is in the header files because the API is  
in the header files, and the documentation goes with the API. This is  
what Growl does.

Having the docs in the .m files puts lots of implementation code in  
between runs of documentation, which makes the documentation hard to  
read (which has the side-effect of making it more important to adhere  
to Doxygen rules so that Doxygen HTML can be generated, since that's  
the only way to effectively study the API without constantly  
scrolling past bunches of implementation).
___________________________________
\ Peter Hosey / boredzo at adiumx.com
PGP public key ID: C6550423 (since 2007-01-01)


-------------- next part --------------
A non-text attachment was scrubbed...
Name: PGP.sig
Type: application/pgp-signature
Size: 186 bytes
Desc: This is a digitally signed message part
URL: <http://adium.im/pipermail/devel_adium.im/attachments/20070317/347844ca/attachment.sig>