[Adium-devl] Adium documentation

[disposable at infinitenexus.com]

On Mar 18, 2007, at 2:45 PM, Peter Hosey wrote:

> On Mar 18, 2007, at 12:35:49, disposable at infinitenexus.com wrote:
>> Although it means more work I fall into favoring a dual approach -  
>> verbose headers that plugin devs will find useful … with plenty of  
>> documentation in the implementation files (all of the codebase)  
>> that lists notes about design decisions, gotchas, etc. and provide  
>> clarity into the working of the method.
>
> Totally.
>
> I think we're all talking about API docs, though. Implementation  
> comments belong in the implementation; there's no question about that.

A marked increase of our use of them to document all I noted would be  
useful, API discussion or no ;) Those .m can be comment spartan  
pretty often. (yes, yes, code documents itself - your thought  
processes and found gotchas, however, do not)

> ___________________________________
> \ Peter Hosey / boredzo at adiumx.com
> PGP public key ID: C6550423 (since 2007-01-01)
>
>
> _______________________________________________
> Adium-devl mailing list
> Adium-devl at adiumx.com
> http://adiumx.com/mailman/listinfo/adium-devl_adiumx.com