Re: [Doxygen-users] doxygen best practices?

[Travis E. <tra...@gm...>]

Zach,

As far as I understand, the primary use of tags like these is to be able to
document elements from outside of the code flow (usually in a separate
file), in case you need or prefer to separate them. I think secondary use
is if Doxygen can't identify some element in your language. Personally, I
wouldn't duplicate those values if you're putting the comments directly
before the documented element and Doxygen is correctly identifying it.

Regarding best practices, the best luck I've had is with style guides for
individual projects/companies. It's good to keep your scale, time,
resources, and specific documentation needs in mind. An exhaustive
best-practice that gets ignored because everyone is overworked won't help
much. A good start for sampling some of these style guides is just a google
search: https://www.google.com/search?q=doxygen+style+guide

Cheers,
Travis

On Wed, Feb 21, 2018 at 2:52 AM, Zack Snyder <za...@gm...> wrote:

> 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
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>