[Opensim-dev] API documentation

[Justin Clark-Casey]

Mike Mazur wrote:
> Hi,
> 
> On Sun, 16 Nov 2008 19:23:00 -0800 (PST)
> Charles Krinke <cfk at pacbell.net> wrote:
> 
>> Is there any
>> reason why we cannot solicit small "comment type" patches to add
>> summaries for namespaces and classes that are currently blank to help
>> our documentation along?
> 
> I can't think of a reason. Helping with documentation is a great way to
> contribute to an open source project. Becoming familiar with the
> codebase by documenting and reading it can be a great way to become a
> developer.

+1  As far as I'm concerned, such summary documentation patches for classes and methods are most welcome.  Other inline 
comment patches are also good, though I think it's important not to go overboard where the code can speak for itself. 
For example, an extreme case would be

// Increment the number by one
number++;

-- 
justincc
Justin Clark-Casey
http://justincc.wordpress.com