如何帮助解决多个目录"?

时间:2018-04-25 17:03:41

标签: c++ doxygen

在我们的项目中,我们有以下目录结构:

gambit
gambit/Utils
gambit/Utils/include/gambit/Utils
gambit/Utils/src
gambit/Core
gambit/Core/include/gambit/Core
gambit/Core/src
...

等等。我们这样做是为了在我们的文件中有一个干净的包含结构,如下所示:

#include "gambit/Utils/somefile.hpp"

我们用-Igambit/Utils/include编译等等。现在我想在此目录树中为每个级别添加doxygen文档。但是我怎么能这样做呢?我似乎无法避免warning: \dir command matches multiple directories。例如,假设我想记录根目录,我似乎别无选择,只能编写例如。

/// \dir gambit
/// \brief Root of GAMBIT source tree
///
/// Some long description

然而,这给了我warning: \dir command matches multiple directories,因为它匹配根目录,以及这两个目录:

gambit/Utils/include/gambit
gambit/Core/include/gambit

但这是项目的根目录,我无法在路径名中添加任何内容以使其唯一,因为没有什么可以添加的! gambit/Utilsgambit/Core歧义存在同样的问题。有没有办法告诉doxygen更喜欢较短的比赛?目前它似乎在其选项之间随机挑选。使用长名称记录其他目录似乎没有帮助,看起来doxygen没有使用该信息返回并解决早期的冲突。

0 个答案:

没有答案