【发布时间】:2018-05-07 15:08:10
【问题描述】:
Doxygen 版本:1.8.12 --默认配置
我一直在使用 Doxygen 生成我的 Python 文档。它在记录类时运行良好。然而,我现在已经构建了几个具有一些功能的模块,我正在记录如下:
## @file
# my module comment
##
# my function
# @return 0
def func():
return 0
然后它会创建一个标签Files,我可以在其中找到我的模块文件。但是,当我单击它们时,功能列表会显示为链接,这些链接已损坏(单击页面时会重定向到自身),并且模块的实际定义会附加在页面末尾。
我应该怎么做才能避免链接断开,也许与类(函数具有单独的 html)发生的类似行为更可取
====更新==== 在检查生成的 html 代码时,显然链接指向这种风格的地址:
Documtenation/myfilepy.html#some_hash
而实际的页面部分具有这种样式的 id:
file_some_hash
调用链接的正确方法应该是:
Documentation/myfilepy#file_some_hash
如何让 doxygen 删除 file_ 或正确生成链接?
【问题讨论】:
-
请指定 doxygen 版本。请创建一个 MWE,以便我们尝试重现该问题。当 \file 命令用于它所描述的同一文件时,请不要使用
参数 n 否则请注意它具有正确的扩展名。 -
我现在已经添加了版本。代码给出了最小的工作示例,因为我使用了 doxygen 的默认配置
-
@albert 你能澄清一下你的意思,不要使用文件名参数,以便我可以更正它吗?谢谢
-
当您在
<filename>中有带有\file的评论时,只需使用@file而不是\file <filename>。 -
当然,我可以做到这一点.. 但同样不能解决问题:P
标签: python automation documentation doxygen