小编Sea*_*tis的帖子

tl;博士问题:

doxygen用于查找doxygen注释中引用的图像的实际算法是什么？结果是什么被认为是未来doxygen版本不会破坏的最佳实践？

细节:

我们正在尝试制定一项政策,其中与doxygen评论相关联的任何图像都应该本地化到参考,这意味着我们将在整个源树中分布图像.显然,我们需要确保我们适当地参考图像,并且doxygen可以找到它们来生成正确的文档.

该Doxygen文档状态:

doxygen将在IMAGE_PATH标记之后指定的路径(或文件)中查找文件

然而,在我的修修补补中,我得出的结论是,这似乎并不完全正确.以下是一些实验结果:

================================================

实验

文件系统配置:

/full/
   path/
      doxygen.cfg
      to/
         this/
            header.h
            images/
               image.png
      other/
         images/
            image.png

doxygen配置文件位于树的"根"(即/full/path/)中,doxygen从同一个文件夹执行.header.h引用images/image.png位于同一个树(/full/path/to/this)中.树中的其他位置有一个名称相同的图像文件. header.h有线:

@file html [filename]

参考在哪里[filename]是以下之一:

1. image.png
2. images/image.png
3. ./images/image.png
4. /full/path/to/this/images/image.png

然后我玩IMAGE_PATH变量.

案例1 :( IMAGE_PATH = 即没有定义路径).

1. 加载"错误"图像(other/iamges/image.png)
2. 没有图像
3. 没有图像
4. 正确加载图像

情况2 :( IMAGE_PATH = /full/path提供给root的路径,但不是头文件的完整路径).

1. 正确加载图像
2. 正确加载图像
3. 正确加载图像
4. 正确加载图像

情况3: IMAGE_PATH = /full/path/other(它提供给根路径不包含头文件).

1. 加载"错误"图像(other/iamges/image.png)
2. 加载"错误"图像(other/iamges/image.png)
3. 加载"错误"图像(other/iamges/image.png)
4. 正确加载图像

================================================ …