\ file命令中的路径出现Doxygen问题

时间:2012-05-21 13:43:45

标签: c doxygen

我使用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输出)

1 个答案:

答案 0 :(得分:1)

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

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

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

如果示例包含用法示例,则最好不要在输入中包含这些示例,而是使用@snippet,@ include或@example代替并将EXAMPLE_PATH指向示例目录。