SVN关键字显示在doxygen中
SVN keyword is shown in doxygen
我在我的项目中使用了 svn 关键字($Author$, ...)。我还使用 doxygen 注释来改进我的文档。两者的结合给我带来了一些麻烦。
简化示例:
/**
* @author $Author$
*/
@author 是 doxygen 关键字,$Author$ 是 svn 关键字。我的 doxygen-html- 输出如下所示:
我怎样才能正确地做到这一点?我不想在我的 doxygen 文档中看到 svn-keywords。
SVN 关键字总是以一种方式展开,以表明特定字符串是展开的关键字而不是 "regular" 行。换句话说,扩展关键字将始终包含美元符号和关键字名称。这样做的原因之一是避免混淆自动关键字生成的内容和非生成的内容。
但是,您应该能够配置 Doxygen 以重新格式化包含扩展关键字的行。例如,将其配置为在一行中查找 $Author: CONTENT $
并根据需要在 HTML 输出中重新格式化它。
我过去所做的是我有一个版本化的模板 doxygen (doxy.in) 文件,其中包含以下内容:
/**
* @author $Author$
*/
当我开始构建我的文档 (make doc
) 时,我的脚本首先调用 SubWCRev 以将这些关键字的所有实例替换为 SVN 关键字。我用它来生成一个未版本化的 doxygen 文件 doxy.out
,然后我将其传递给 doxygen 以生成我的文档。
我在我的项目中使用了 svn 关键字($Author$, ...)。我还使用 doxygen 注释来改进我的文档。两者的结合给我带来了一些麻烦。
简化示例:
/**
* @author $Author$
*/
@author 是 doxygen 关键字,$Author$ 是 svn 关键字。我的 doxygen-html- 输出如下所示:
我怎样才能正确地做到这一点?我不想在我的 doxygen 文档中看到 svn-keywords。
SVN 关键字总是以一种方式展开,以表明特定字符串是展开的关键字而不是 "regular" 行。换句话说,扩展关键字将始终包含美元符号和关键字名称。这样做的原因之一是避免混淆自动关键字生成的内容和非生成的内容。
但是,您应该能够配置 Doxygen 以重新格式化包含扩展关键字的行。例如,将其配置为在一行中查找 $Author: CONTENT $
并根据需要在 HTML 输出中重新格式化它。
我过去所做的是我有一个版本化的模板 doxygen (doxy.in) 文件,其中包含以下内容:
/**
* @author $Author$
*/
当我开始构建我的文档 (make doc
) 时,我的脚本首先调用 SubWCRev 以将这些关键字的所有实例替换为 SVN 关键字。我用它来生成一个未版本化的 doxygen 文件 doxy.out
,然后我将其传递给 doxygen 以生成我的文档。