On 08/26/2013 04:09 PM, Jakub Hrozek wrote:
On Mon, Aug 26, 2013 at 09:55:37AM -0400, Simo Sorce wrote:
> On Mon, 2013-08-26 at 15:40 +0200, Jakub Hrozek wrote:
>> On Mon, Aug 26, 2013 at 09:28:12AM -0400, Simo Sorce wrote:
>>> P.S: should we start using docbook syntax for this type of comments?
>>> I use them elsewhere and it make it possible to create documentation
>>> quite easily.
>> docbook or doxygen?
> Doxygen, sorry.
We already do for public interfaces. For private interfaces, it's more
of a nice to have in my opinion. But why not, if we're adding a comment
anyway, we can also format it nicely..
I think we should comment our internal API a bit more, but doxygen is
IMO overkill for this purpose, but I am not strictly against it.