[haiku-commits] Re: haiku: hrev47428 - src/kits/app docs/user/app headers/os/app docs/user/support
- From: John Scipione <jscipione@xxxxxxxxx>
- To: "haiku-commits@xxxxxxxxxxxxx" <haiku-commits@xxxxxxxxxxxxx>
- Date: Wed, 25 Jun 2014 17:07:57 -0400
On Wed, Jun 25, 2014 at 4:57 PM, Axel Dörfler <axeld@xxxxxxxxxxxxxxxx> wrote:
> On 06/25/2014 09:39 PM, jscipione@xxxxxxxxx wrote:
>>
>> +// Finds an application associated with a MIME type.
>> status_t
>> BRoster::FindApp(const char* mimeType, entry_ref* app) const
>
> This is superfluous documentation.
> Also, as I had just told you a couple of days ago, we still use doxygen
> style comments for internal documentation of functions!!!
Wait, I'm confused. I really want to get this right.
Firstly, I kept all the private method documentation in the cpp file
and kept it in doxygen format.
For the public methods I moved the documentation to the Haiku Book. I
don't want to have documentation in 2 places since we'd have to update
both so I removed it from the cpp file.
I kept the brief description in the cpp file though as a regular
comment just so that you know what the method is suppose to do without
having to look at the Haiku Book. I could remove that as well but it
is helpful and it's short. It would be silly to have this in doxygen
format since it's just the brief and the real docs are in the Haiku
Book, but I could add a ! after the // if that would make you happy.
Please help me understand!
Other related posts:
