doxygen - 关于控制 Doxygen 中的枚举文档的问题
问题描述
我正在使用 Doxygen 来记录 C++ 库。枚举的文档几乎没有它可能的帮助,而且我找不到任何关于控制输出的信息。生成的输出将未记录版本的枚举放在命名空间页面顶部的“枚举”部分中,其中的各个元素链接到实际有用的文档,位于枚举类型文档部分下。在一个真实的例子中,在页面到达 Enumeration Type Documentation 部分之前,可能有许多这些未记录的枚举,在该部分可以找到记录每个值的使用的有用帮助。
如何完全禁止枚举部分,同时保留实际记录枚举值的枚举类型文档部分?
输出是从此示例 .h 文件生成的:
//! \file
#pragma once
//! \brief My main namespace
namespace MyNamespace
{
//! \brief An example enumeration with the useful values documented.
enum class MyExampleEnum
{
UNKNOWN,
FirstValue, //!< This is the useful documentation
SecondValue, //!< This is useful documentation of SecondValue
COUNT,
};
}
解决方案
推荐阅读
- html - 网页上托管的目录的url被点击时,默认模板是如何创建的?
- laravel - 动态自定义字段:JSON、Pivot、morphToMany?
- powershell - How to execute .exe tool with argument using Powershell script?
- log4j2 - 更改 log4j2 日志条目的级别
- ios - Play background music for 24 hours (sleep music app)
- sql-server - 如何根据函数中的条件返回值?SQL 服务器
- java - swapping lines between Session.save() . what changes happens in the output . Kindly see the comment in the code. i'm new in java hibernate
- python - How to merge two different dataframe with a slight difference in timestamp
- java - 如何在项目结构的特定位置创建 .project 描述文件
- laravel - Laravel - Advanced Sum Aggregate in Laravel Eloquent