从doxygen生成的html中删除作者和日期 < >我有C++代码,使用DoXyGrand风格的注释进行注释。 我们使用下面的模板。 根据文档的使用情况(内部与外部),我们希望删除生成的html中的作者和日期。 是否有从自动生成的html中删除作者和日期的选项? 谢谢 保罗
如果不对标题格式进行某种修改,这将很难实现。第一个也是最明显的尝试是使用从doxygen生成的html中删除作者和日期 < >我有C++代码,使用DoXyGrand风格的注释进行注释。 我们使用下面的模板。 根据文档的使用情况(内部与外部),我们希望删除生成的html中的作者和日期。 是否有从自动生成的html中删除作者和日期的选项? 谢谢 保罗,doxygen,Doxygen,如果不对标题格式进行某种修改,这将很难实现。第一个也是最明显的尝试是使用\cond和\endcond条件命令(或\ifndef DOXYGEN\u应跳过此选项),如中所述 您可能会考虑的另一个技巧将要求您重新排序 > bug >代码>代码> >日期>代码>命令,因此代码> >作者 >代码> \DATE 在相邻的行上。如果您这样做,您的标题将如下所示: /*! * \file Document.h * \brief This header file will be useful for t
\cond
和\endcond
条件命令(或\ifndef DOXYGEN\u应跳过此
选项),如中所述
您可能会考虑的另一个技巧将要求您重新排序<代码> > bug >代码>代码> >日期>代码>命令,因此代码> >作者<代码> >代码> \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.
*/
通过以这种方式排序,您可以在Doxygen配置文件中使用一些别名技巧来获得所需的结果。通过更改\author
和\bug
的定义,您可以让Doxygen动态插入注释命令,忽略它们之间的作者和日期信息。在配置文件中使用下面的行应该会导致author/date条目从所有HTML输出中消失
ALIASES = author="<!--"
ALIASES += bug="-->\bug"
alias=author=“\bug”
这并不完全是Doxygen的设计特性,但它是一种可以做到这一点的技巧。如果不对标题格式进行某种修改,这将很难实现。第一个也是最明显的尝试是使用
\cond
和\endcond
条件命令(或\ifndef DOXYGEN\u应跳过此
选项),如中所述
您可能会考虑的另一个技巧将要求您重新排序<代码> > bug >代码>代码> >日期>代码>命令,因此代码> >作者<代码> >代码> \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.
*/
通过以这种方式排序,您可以在Doxygen配置文件中使用一些别名技巧来获得所需的结果。通过更改\author
和\bug
的定义,您可以让Doxygen动态插入注释命令,忽略它们之间的作者和日期信息。在配置文件中使用下面的行应该会导致author/date条目从所有HTML输出中消失
ALIASES = author="<!--"
ALIASES += bug="-->\bug"
alias=author=“\bug”
这并不完全是Doxygen的设计特性,但它是一个应该做到这一点的黑客。完全删除作者和日期
这些信息甚至不应该在doxygen中,这就是源代码管理(即,
git
)的目的。完全删除作者和日期
此信息甚至不应出现在
doxygen
中,这是源代码管理(即git
)的目的。您可以使用doxygen的\internal
命令-请参阅
基本上,您需要稍微调整标题示例,将要排除的元素(作者、日期)放在\internal命令之后:
/*!
* \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中,您可以启用/禁用内部\u DOCS
设置
稍微高级一点的是
\if
和\cond
命令,这将使您能够更细粒度地控制出现的内容,因此您可以为不同的用户组提供三个或更多不同版本的文档。请参见您可以使用doxygen的\internal
命令-请参见
基本上,您需要稍微调整标题示例,将要排除的元素(作者、日期)放在\internal命令之后:
/*!
* \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中,您可以启用/禁用内部\u DOCS
设置
稍微高级一点的是
\if
和\cond
命令,这将使您能够更细粒度地控制出现的内容,因此您可以为不同的用户组提供三个或更多不同版本的文档。有关更新版本的doxygen,请参见,如果使用示例中所示的单行命令,并且必须删除所有出现的命令,则更容易操作。自doxygen版本1.8.17以来,命令\noop
已存在(请参阅):
\noop(要忽略的文本)
所有文本,包括命令,直到行尾被忽略。该命令通常与别名结合使用,以忽略其他处理工具中不受支持的命令
因此,向doxygen配置文件中添加以下行就足够了:
ALIASES += author=\noop
ALIASES += date=\noop
对于较新版本的doxygen,如果有一行命令(如示例中所示)并且必须删除所有出现的命令,则更容易。自doxygen版本1.8.17以来,命令
\noop
已存在(请参阅):
\noop(要忽略的文本)
所有文本,包括命令,直到行尾被忽略。该命令通常与别名结合使用,以忽略其他处理工具中不受支持的命令
因此,向doxygen配置文件中添加以下行就足够了:
ALIASES += author=\noop
ALIASES += date=\noop
\author
不仅仅是用于类似于blamelog的目的(你是对的,应该在SCM中跟踪它们)。它还用于版权和授权。\author
不仅仅用于类似于blamelog的目的(你是对的,它们应该在SCM中跟踪)。它还用于版权和许可方面。