use file or class for documenting classes in doxygen?
Posted
by
AlejandroVK
on Stack Overflow
See other posts from Stack Overflow
or by AlejandroVK
Published on 2011-02-09T15:22:55Z
Indexed on
2011/02/09
15:25 UTC
Read the original article
Hit count: 175
Hi all,
This surely is a noob question, but I can't find an answer in Doxygen documentation. I'm not sure whether using:
@file
or
@class
when documenting my header files.
The reason is that if I put file, then all the comments appear in the Files tab only, but not in the Classes tab (per each).
For cpp it's ok, I just use file and it's good, but if I use both file and class in the header (file at the beginning and class right before the start of the class declaration) then I get duplicated entries for the class in the generated documentation...
What I'm doing wrong? Any suggestions? Ideas?
Regards, Alex
© Stack Overflow or respective owner