【发布时间】:2013-08-04 00:14:21
【问题描述】:
我使用 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 有类似的问题,但主题作者的解决方案对我不起作用。
提前感谢您的帮助。
编辑1: 我只是尝试使用 doxygen 生成 Java API 以获取相应的标记文件。然后,我将此文件与此演示项目一起使用,其中我添加了一个构造函数,使用一个参数作为 JList => 仅针对此参数解析链接,从不使用链接命令。
编辑2:
我终于成功地保留了这种签名:{@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) {
}
}
最终结果:
但是,构建 .chm 帮助文件几乎是不可能的,因为完成这项任务需要一段时间,而且您会得到一个非常大的文件。但这是另一个问题......
【问题讨论】: