doxygen best practices?

"Zack Snyder" <[email protected]> Wed, 21 Feb 2018 09:52:57 +0100

Newsgroups	gmane.text.doxygen.general
Message-ID	<trinity-1dbabd1e-5193-4450-b886-21748dd0de47-1519203177746@3c-app-gmx-bs16>

Hi there,

when I document my classes always in front of the declaration,

like this:

/*!

* \class MyClass

*

* \brief Some description

*

*/

struct MyClass

{

};

Is it still usefull to use the \class tag?

Or is it redundant and should be avoided,

because it violates the DRY rule?

Regards,

zack

PS: Are there andy best practices for doxygen? What makes sense to use, what not?

------------------------------------------------------------------------------
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot

_______________________________________________
Doxygen-users mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/doxygen-users