CODEWITHSUNDEEP
c++enumsdoxygen
Kat
Kat

Reputation: 4695

Doxygen doesn't generate documentation for enum not in class

I have an enum inside of a namespace, but outside of a class. The enum is not being documented by Doxygen unless I enable EXTRACT_ALL, which extracts way too much unnecessary content.

The place where it's used doesn't link the enum (it does if I use EXTRACT_ALL). The enum and its members are documented (and the documentation shows up as expected with EXTRACT_ALL). Without that setting, the enum doesn't show up in the documentation anywhere.

Is there some other setting that I could use that would be more precise than using EXTRACT_ALL?

I currently have EXTRACT_PRIVATE, EXTRACT_PACKAGE, EXTRACT_STATIC, EXTRACT_LOCAL_CLASSES, and EXTRACT_ANON_NSPACES enabled, with the various HIDE_* settings being off.

Upvotes: 6

Views: 5884

Answers (1)

Cheeseminer
Cheeseminer

Reputation: 3078

Check to see if the file contains a \file command.

From the manual for \file (my emphasis) :

The documentation of global functions, variables, typedefs, and enums will only be included in the output if the file they are in is documented as well.

See here.

Upvotes: 6

Related Questions