我希望Doxygen记录用类C语言(PARI / GP)编写的代码,但语法略有不同。我相信Doxygen可以记录那些不存在的实体。当编程语言不支持Doxygen时,这似乎是最简单的工作方式。我想要这样的东西:
/*!
\fn foo(param,{option})
\brief some brief description here
\param[in](param) mandatory parameter description
\param[in](option) optional parameter description
*/
/*! \cond DOXYGEN_SHOULD_SKIP_THIS */
foo(param, {option}) =
{
...
};
addhelp(foo, "help message for `foo` function");
/*! \endcond */
不幸的是,Doxygen会生成警告“文档符号'foo'未声明或定义”,并且未在输出HTML中列出foo
。有没有办法强制Doxygen只使用文档块而不是代码生成正确的HTML?
有各种选择
#if DOXYGEN_ONLY
/**
\brief some brief description here
\param[in](param) mandatory parameter description
\param[in](option) optional parameter description
*/
void foo(param,option);
#endif
foo(param, {option}) { ... };
然后在配置文件中定义以下内容:
PREDEFINED = DOXYGEN_ONLY