Documenting classes with doxygen

Question

I am trying to follow these doxygen examples, but nothing shows up. I run doxygen Doxyfile, and check the index.html file, but nothing is there. Only stuff that is in my mainpage.dox file, nothing to do with any classes. Ideally I'd have a class list, with this particular class I documented in it.

Perhaps it's my file structure. Does Doxygen just recurisvely search the root directory, or does it look for files with a special tag?

You have to tell it which files to include in your Doxyfile. Look at the documentation to find out which configuration option it is. Check this link: stack.nl/~dimitri/doxygen/manual/starting.html#step1 — Anon Mail
@AnonMail playing around with the INPUT and FILE_PATTERNS tagnames doesn't do anything. Their default values should work, though. What made it work was setting RECURSIVE = YES thanks for the help — Taylor
Are you giving the full path names? Or running doxygen in the directory where your code resides? Why not post your Doxyfile? — Anon Mail

JymmyZ JymmyZ · Accepted Answer · 2017-11-03T18:26:03

I found that I had to use both the @class parameter, as well as a brief description of the Class before that class was listed in the Class section of my generated documentation.

Documenting classes with doxygen

1 Answers