[Adium-devl] Adium documentation

[Colin Barrett]

We've generally put the documentation in the .m files. When we (i  
believe Evan came up with the idea) decided this, our reasons were:

- Keeps the documentation right near the code, possibly increasing the  
chances they will stay in sync
- I remember something about avoiding cluttering up the header files,  
but I'm not sure why that would matter
- Usually documentation is put in header files because the  
implementation will be closed-source. Adium doesn't have this problem.

I'm fine with the current policy, and thanks for taking the time to go  
and clean up the docs!

CC-ing devl in case anyone else wants to disagree.

-Colin

On Mar 15, 2007, at 3:45 PM, Michael Dippery wrote:

> Hello,
>
> I've been going through the Adium source and tweaking some of the  
> documentation. Since I seem to recall that there's been attempts in  
> recent months to clean up some of the documentation, I'd be happy to  
> clean up or even create some Doxygen documentation and submit my  
> patches. I have a question, though: So far, the current style seems  
> to be writing the source documentation in the implementation (.m)  
> files, although it seems "standard" to write documentation into the  
> header files. Of course, some of Adium's documentation is in .h  
> files, too. In adding documentation, should I continue with the  
> current style, which seems to be placing documentation in .m files,  
> or would you prefer the documentation to be in the .h files?
>
>
>
> --
> Michael Dippery
> mdippery at bucknell.edu
>