[haiku-commits] Re: haiku: hrev45377 - src/kits/interface headers/os/interface

  • From: Axel Dörfler <axeld@xxxxxxxxxxxxxxxx>
  • To: haiku-commits@xxxxxxxxxxxxx
  • Date: Sun, 17 Mar 2013 17:10:37 +0100

On 03/17/2013 04:48 PM, John Scipione wrote:
On Sun, Mar 17, 2013 at 4:53 AM, Axel Dörfler <axeld@xxxxxxxxxxxxxxxx> wrote:
Please don't do that -- we use doxygen style for private functions
everywhere. And while they don't end up in the Haiku book, there is no
reason we'll never create a class documentation for it.
If we really use doxygen style for private functions everywhere then
we should put them in the Haiku book. I don't see an API docs for
private functions ever happening, either we document them in the Haiku
book or we document them in the source, and if we document them in the
source, there's no reason to use doxygen style comments as it clutters
the code for no gain.

Is there any reason to deviate from the status quo? I don't see any.
Even if we never create a doxygen documentation for the private functions, what's the point? And no, private functions have no place in the Haiku book. The Haiku book is for public API only.

 From now on I'll leave private function docs alone, I was only trying
to help reduce clutter.

How is it clutter to have a function documented with either comment style?

Bye,
   Axel.


Other related posts: