[Adium-devl] Adium documentation

[Peter Hosey]

On Mar 18, 2007, at 14:17:39, Evan Schoenberg wrote:
> (3) Private classes -- such as components -- should be  
> documented... in the implementation, on the basis that the header  
> file is largely unused and its the local implementation that mattters

Every class is an API, even if we're the only application that's to  
ever program it (that is, even if it's a private API). The docs for  
that API should go in the header, whether the API is public or private.

Stated differently: Every API has some balance between publicity and  
privacy. A “public” API is exposed to other applications or plug-ins.  
A “private” API isn't, but it's still exposed to other classes within  
the same application. Only the implementation is truly private, not  
exposed to anybody but itself. Therefore, only the implementation  
(and comments regarding it) should be in the implementation files.
___________________________________
\ 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/20070318/9d0651c9/attachment.sig>