\file 命令中路径的 Doxygen 问题答案

【问题标题】：Doxygen problems with paths in \file command\file 命令中路径的 Doxygen 问题
【发布时间】：2012-05-21 13:43:44
【问题描述】：

我在使用 Doxygen 1.7.x 时遇到了以下问题：我在一个子目录中记录了各种文件，并且在相应的 Modules 页面上以不同的文件名样式引用它们，包括有和没有它们的路径。但我想在模块页面上有相对路径（w.r.t. 项目根目录）。

这两个文件标记如下：

/**
 * @addtogroup examples_itsolver
 * @{ 
 * @file example/itsolver/bicgstab_1.c 
 * @brief Demostrate the usage of BiCGStab 
 * @date 05/21/2012 
 * @version $Id$
 *@}
 */

和

/**
 * @addtogroup examples_itsolver
 * @{ 
 * @file example/itsolver/sor.c 
 * @brief Demostrate the usage of SOR
 * @date 05/21/2012 
 * @version $Id$
 *@}
 */

这会导致

file    bicgstab_1.c
        Demonsrate the usage of BiCGStab.

file    example/itsolver/sor.c
        Demonstrate the usage of the SOR Iterative Solver.

在Module overview 页面上。但我希望在整个项目中记录所有文件，如sor.c。我怎样才能做到这一点？使用 FULL_PATH_NAMES 配置选项没有帮助。

http://www-e.uni-magdeburg.de/makoehle/doxygen_error.tgz 上提供了完整示例（包括生成的 html 输出）

【问题讨论】：

我无法使用您提供的信息重现此内容。如果您有一个独立的示例（zip 中的源代码+配置文件）演示该问题，请在 doxygen 错误跟踪器中提交错误报告并附上示例。

标签： c doxygen

【解决方案1】：

问题是在您的示例中有两个名为 sor.c 的文件

example/itsolver/sor.c
lib/itsolver/sor.c

doxygen 将根据需要添加尽可能多的路径以使名称唯一。

如果 example 包含使用示例，那么最好不要在输入中包含这些，而是使用 @sn-p、@include 或 @example 并将 EXAMPLE_PATH 指向您的示例目录。

【讨论】：