Doxygen about opentesarena HOT 6 CLOSED

I've seen Doxygen used by a big project before; namely, the physically-based renderer pbrt. I haven't used it myself yet, but standardizing comments in this project sounds like a great idea. I'll see about starting to add conforming comments to the code soon.

from opentesarena.

Which document style do we want to use in this app? It looks like several are supported in Doxygen.

from opentesarena.

I think using //! for single-line comments is the most intuitive for me. I haven't gotten around to this issue because I've just been solving other problems in the meantime.

from opentesarena.

I assume that means that multi-line comments look like this then:

/*! 
 * A longer block
 */

I asked because I was interested in adding some documentation to a few classes and was unsure about the preferred style.

from opentesarena.

Hmm, maybe use

//! Description for a class method
//! that needs to be multi-line.

I haven't tried it in practice yet but I think that's how I would do it. I don't really use /* */ anywhere in the code on a regular basis, so the double forward slash + exclamation mark would be the go-to option.

I assume these styles would take some experimenting with before the most convenient one becomes evident.

from opentesarena.

Decided not to use Doxygen or any doc generation yet. Will re-evaluate this if there's enough demand.

(also this is nearly a 7 year old issue, whoops)

from opentesarena.