CODEWITHSUNDEEP
doxygen
jwhitmore
jwhitmore

Reputation: 203

Documentation not appearing in doxygen output

I'm trying to document a C API which is all contained in a single C Header file. When I run doxygen, on the file, it's giving me errors for currently undocumented C Macros, but when I add the necessary documentation for macros, although the undocumented errors are cleared, the macros plus documentation do not appear in the doxygen generated html output.

Only a fraction of the documented header file, the structures, actually appears in any doxygen output. I can't see anything in configuration settings or documentation that would assist in clarifying why doxygen does not place documented code from the header file into its generated output.

Does anybody know why this would be the case?

Upvotes: 7

Views: 19619

Answers (2)

Erty Hackward
Erty Hackward

Reputation: 64

In my case I tried to feed my xml files to oxygen. It does not work with xml as input. You need to feed actual source files.

Upvotes: 0

doxygen
doxygen

Reputation: 14869

See items 2 and 3 of the FAQ: http://www.doxygen.org/manual/faq.html

In short you are likely missing a comment block with @file to document your header file.

Upvotes: 4

Related Questions