Documentation not appearing in doxygen output

Question

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?

doxygen · Accepted Answer · 2013-09-07 18:07:36Z

4

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.

answered Sep 7, 2013 at 18:07

doxygen

15k2 gold badges45 silver badges40 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

jwhitmore Over a year ago

The @file comment is in the file and none of the solutions in the faq make a difference. They are written in a class based way talking about namespaces but since I'm a straight C Header so that might explain why the faq solutions aren't helping me.

doxygen Over a year ago

@file should have worked, so please post a self-contained example (either here or in doxygen's bug tracker) so I can reproduce the problem myself.

jwhitmore Over a year ago

Oops! The @file does document a lot more, in the actual file documentation but what I'm really missing is the API functions. Unfortunately in the header the API functions are declared as C pointers to functions. I'm documenting them with a "\fn" but these don't show up at all.

Erty Hackward · Accepted Answer · 2023-07-20 12:49:11Z

0

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.

answered Jul 20, 2023 at 12:49

Erty Hackward

644 bronze badges

Collectives™ on Stack Overflow

Documentation not appearing in doxygen output

2 Answers 2

3 Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

3 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related