Question

我有使用doxygen风格注释评论的C ++代码。我们使用下面的模板。根据文档的使用（内部与外部），我们希望在生成的html中删除作者和日期。是否有从自动生成的html中删除作者和日期的选项？谢谢！保罗

/*!
*  \file Document.h
*  \brief This header file will be useful for the doxygen.
*
*  \author John.Doe
*  \bug    No known bugs.
*  \date   3/20/2016 
*/

Answer 1

如果不对标题格式进行某些修改，这将很难实现。第一个也是最明显的尝试是使用\cond中讨论的\endcond和#ifndef DOXYGEN_SHOULD_SKIP_THIS条件命令（或\bug选项）。

您可能考虑的另一个技巧是要求您重新排序\date和\author命令，以便\date和/*! * \file Document.h * \brief This header file will be useful for the doxygen. * * \author John.Doe * \date 3/20/2016 * \bug No known bugs. */位于相邻的行上。如果您这样做，您的标题将如下所示：

\author

通过这种方式排序，你可以在Doxygen配置文件中使用一些别名技巧来获得你想要的结果。通过更改\bug和ALIASES = author="\bug"的定义，您可以告诉Doxygen即时插入注释命令，忽略它们之间的作者和日期信息。在配置文件中使用以下行应该使作者/日期条目从所有HTML输出中消失。

git rebase <master>

这不是Doxygen的设计特征，但它应该可以解决问题。

Answer 2

完全删除作者和日期。

此信息甚至不应在doxygen中，这是源控制管理（即git）的用途。

Answer 3

您可以使用doxygen的\internal命令 - 请参阅http://www.doxygen.nl/manual/commands.html#cmdinternal

基本上你需要稍微调整你的标题示例：

/*!
*  \file Document.h
*  \brief This header file will be useful for the doxygen.
*
*  \bug    No known bugs.
*  \internal
*  \author John.Doe
*  \date   3/20/2016 
*/

然后在您的Doxyfile中，您可以启用/禁用INTERNAL_DOCS设置。

稍高级的\if和\cond命令可以让您对显示的内容进行更细粒度的控制，因此您可以为不同的用户组提供三个或更多不同版本的文档。见http://www.doxygen.nl/manual/commands.html#cmdif

Answer 4

对于较新版本的doxygen，如果像示例中那样只有一个命令行命令并且必须删除所有出现的命令，则更加容易。从doxygen版本1.8.17开始，命令\noop存在（请参阅https://www.doxygen.nl/manual/commands.html）：

\ noop（文本将被忽略）

所有文本，包括命令，直到行尾都将被忽略。该命令最常与ALIASES结合使用，以忽略不支持的命令，例如存在其他处理工具。

因此将以下行添加到doxygen配置文件中就足够了：

ALIASES += author=\noop
ALIASES += date=\noop

从doxygen生成的html中删除作者和日期

4 个答案: