[openbeos] Re: First draft of the API documentation guidelines

  • From: Ingo Weinhold <bonefish@xxxxxxxxxxxxxxx>
  • To: openbeos@xxxxxxxxxxxxx
  • Date: Tue, 20 Mar 2007 14:07:23 +0100

On 2007-03-19 at 11:04:37 [+0100], Niels Reedijk <niels.reedijk@xxxxxxxxx> 
wrote:
> 
> I just commited the first draft of the API documentation guidelines,
> to start a discussion.

Personally I'm very much in favor of inline documentation (though not in 
the headers for obvious reasons). If for some reason a documentation 
becomes lengthy I don't have a problem with moving it to a separate file, 
but in general I'd prefer it to stay with the implementation.

CU, Ingo

Other related posts: