[Doxygen-users] doxygen best practices?
Brought to you by:
dimitri
Menu
▾
▴
[Doxygen-users] doxygen best practices?
|
From: Zack S. <za...@gm...> - 2018-02-27 18:47:25
|
<html><head></head><body><div style="font-family: Verdana;font-size: 12.0px;"><div>Hi there,<br/>
<br/>
when I document my classes always in front of the declaration,<br/>
like this:<br/>
<br/>
/*!<br/>
* \class MyClass<br/>
*<br/>
* \brief Some description<br/>
*<br/>
*/<br/>
struct MyClass<br/>
{<br/>
};<br/>
<br/>
Is it still usefull to use the \class tag?<br/>
Or is it redundant and should be avoided,<br/>
because it violates the DRY rule?<br/>
<br/>
Regards,<br/>
zack<br/>
<br/>
PS: Are there andy best practices for doxygen? What makes sense to use, what not?</div></div></body></html>
|
