Javadoc使用Doxygen标记@link:无法解析链接

时间:2013-08-02 16:19:07

标签: hyperlink javadoc doxygen

我使用Javadoc进行了记录,我很欣赏与Eclipse的集成,但我想使用Doxygen来添加图表。

我在几个简短的描述中使用标签{link foo}来链接到标准Java类和我自己的类。

这是一个SSCCE:

package org.foo.myproject;

import javax.swing.JList;

/**
 * This is a Javadoc line {@link JList}
 * 
 * @author theauthor
 * @version 1.0.0
 */
public class JavadocLinkFailedDemo {
}

我在Doxygen(1.8.4)中遇到以下错误:Warning: unable to resolve link to JList for \link command(我使用doxygen.exe生成的doxyfile模板,为.java源和特定输入/输出目录编辑)

这是question的类似问题,但主题作者的解决方案对我不起作用。

提前感谢您的帮助。

EDIT1: 我只是尝试使用doxygen生成Java API以获取相应的标记文件。然后,我在这个演示项目中使用了这个文件,我在其中添加了一个构造函数,使用一个参数作为JList =>该链接仅针对此参数进行解析,绝不会使用链接命令解析。

EDIT2: 我终于成功地保留了这种签名:{@ link ...}。 对于我的示例,如果您满足以下条件,则会解析JList:
  - 写出类文件的完全限定名称
  - 使用doxygen生成jdk的文档以生成标记文件并在项目中使用此标记

最后的示例代码是:

package org.foo.myproject;

import javax.swing.JList;

/**
 * This is a Javadoc line with {@link javax.swing.JList}
 * 
 * @author theauthor
 * @version 1.0.0
 */
public class JavadocLinkFailedDemo {
    /**
     * This is a Javadoc line of the constructor with {@link javax.swing.JList}
     * 
     * @param aList
     *            The list
     */
    public JavadocLinkFailedDemo(JList aList) {
    }
}

最终结果:
http://s11.postimg.org/wgndev8hv/doxy_jdk.png

但是,构建.chm帮助文件几乎是不可能的,因为执行此任务需要一段时间,而且文件非常大。但这是另一个问题......

1 个答案:

答案 0 :(得分:0)

我没有尝试过这个,但我相信你需要的是一个逃脱角色@link。这应该看起来像\@link@@link,但我会优先考虑\@link

现在我相信doxygen应该能够正确处理你的javadoc注释,但是我不确定这是否适用于JavaDoc,或者JavaDoc现在是否正在抱怨。你的doxygen文档中也可能看起来很奇怪,因为它应该显示@link JList},...我猜这不完全是你想要的。