[Doxygen-users] Question about controlling the documentation of enumerations

[John S. <joh...@be...>]

Hi,

I’m using Doxygen to document a C++ library. Documentation of enumerations is not nearly as helpful as it might be, and I can’t find anything about controlling the output. I’ve made a small example to illustrate what I mean. The help puts an undocumented version of the enumeration at the top of the namespace page, individual elements of which link to the actual useful documentation, under Enumeration Type Documentation. In a real example, there may be many of these undocumented enumerations before the Help file gets around to the Enumeration Type Documentation section where the useful help documenting the use of each value can be found.

How can I suppress the Enumerations section of the following entirely, while leaving the  Enumeration Type Documentation section that actually documents the enumeration values?

An example page illustrating the problem:

MyNamespace Namespace Reference

My main namespace. More...

Enumerations
enum
MyExampleEnum<namespace_my_namespace.html#a84257abe6faa6a7ce3be15be5c603451> {
  UNKNOWN,
  MyExampleEnum::FirstValue<namespace_my_namespace.html#a84257abe6faa6a7ce3be15be5c603451a72fbccc72f1137a08c4b289d51a0a18c>,
  MyExampleEnum::SecondValue<namespace_my_namespace.html#a84257abe6faa6a7ce3be15be5c603451a9ba5d057430771223955c4723b366b36>,
  COUNT
}

An example enumeration with the useful values documented. More...<namespace_my_namespace.html#a84257abe6faa6a7ce3be15be5c603451>

Detailed Description

My main namespace.

Enumeration Type Documentation
◆ MyExampleEnum
enum MyNamespace::MyExampleEnum<namespace_my_namespace.html#a84257abe6faa6a7ce3be15be5c603451>
strong

An example enumeration with the useful values documented.
Enumerator
FirstValue

This is the useful documentation.
SecondValue

This is useful documentation of SecondValue.


I’ve attached the .h file, but I’m not sending the configuration file or the HTML output file due to space constraints.

Thanks,
John Schmitz


John Schmitz
Lead Software Engineer - Bethesda.net
1370 Piccard Drive | Rockville, MD  20850
[Description: cid:image001.gif@01C9A895.4CFB2250] Main: 301-948-2200  |    [Description: cid:image002.gif@01C9A895.4CFB2250]   Fax: 301-354-4447
[Description: cid:image004.gif@01C9A895.4CFB2250] Website: www.zenimax.com<http://www.zenimax.com/>