如何基于*.dox生成Doxygen报告并仅从源代码中引用

如何基于*.dox生成Doxygen报告并仅从源代码中引用,doxygen,Doxygen,我们需要仅基于.dox文件设置doxygen报告生成。 因此,只需更新doxygen注释,就可以避免对源代码文件进行不必要的更改。 我希望这可以按照我们在doxygen报告生成中的期望完成。 我们同样需要支持 目前,我们已经在FILE\u PATTERNS标记中添加了源文件和其他需要分析以生成报告的扩展名,如下所示: FILE_PATTERNS = *.cpp \ *.hpp \

我们需要仅基于.dox文件设置doxygen报告生成。 因此,只需更新doxygen注释,就可以避免对源代码文件进行不必要的更改。 我希望这可以按照我们在doxygen报告生成中的期望完成。 我们同样需要支持

目前,我们已经在
FILE\u PATTERNS
标记中添加了源文件和其他需要分析以生成报告的扩展名,如下所示:

FILE_PATTERNS          = *.cpp  \
                         *.hpp  \
                         *.c    \
                         *.h    \
                         *.dox
我们的期望是,doxygen注释将从
.dox
文件中完全解析,并生成报告

行为: 我们观察到主页来自
.dox
文件注释,而API、定义、变量定义等的引用来自源代码文件和
.dox
文件(即源代码文件中的doxygen注释)。有时它也只是从源代码中获取,而不是从
.dox
中获取。 这是配置问题还是其他问题? 源文件算术.c包含以下代码

/**
* @brief square of number
* @param[in] value1
* @return int result
* @description square of value
*/
int square(int x)
{
}
输入.dox文件:

/*! \fn int square(int x)
\brief Square of value
\param value1 for addition
\return square of given value.
*/
如果我们使用上述源代码和.dox文件生成doxygen报告,那么doxygen报告将包含源文件和.dox文件中的函数描述,
但我们的要求是从.dox文件中获取描述。

您使用的是哪个版本的doxygen?要知道问题在哪里有点困难,a肯定是有用的。最简单的方法可能是确保文件
算术.c
中没有doxygen注释,所以将
/**
更改为
/*
,至少在我正确理解问题的时候。我们是否可以只使用.dox文件作为doxygen的输入来记录.h和.c文件,以避免源文件对文档的依赖性?据我所知,doxygen无法找到文档所属的函数。当然,您也可以在
.dox
文件中添加原型。整个构造非常容易出错,尤其是将文档放在与代码不同的文件中(很容易忘记记录某些更改,例如参数列表更改时也是如此。如果有两个位置具有类似文档(
.dox
.c
文件),则也很容易出错).我不知道是谁下的订单是“我们需要仅基于.dox文件设置doxygen报告生成。”,但在我看来,这个要求应该重新考虑。您使用的是哪个版本的doxygen?很难说问题出在哪里,a肯定是有用的。最简单的方法可能是确保文件
算术.c
中没有doxygen注释,所以至少在必要时将
/**
更改为
/*
我正确地理解了这个问题。我们是否可以只使用.dox文件作为doxygen的输入来记录.h和.c文件,以避免源文件对文档的依赖性?据我所知,doxygen无法找到文档所属的函数。当然,您可以在
.dox
文件。整个构造非常容易出错,尤其是将文档放在与代码不同的文件中(很容易忘记记录某些更改,例如参数列表更改时也是如此。如果有两个位置具有类似文档,则也很容易出错)(
.dox
.c
文件)。我不知道是谁下的命令是“我们要求仅基于.dox文件设置doxygen报告生成”,但我认为这一要求应该重新考虑。