3

我使用 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 源和特定的输入/输出目录进行了编辑）

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

提前感谢您的帮助。

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 帮助文件，因为完成此任务需要一段时间，而且您会得到一个非常大的文件。但这是另一个问题...

4

1 回答 1

0

我还没有尝试过，但我相信你需要的是一个转义字符@link。这应该看起来像\@linkor @@link，但我更喜欢\@link.

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

于 2013-08-04T08:08:05.007 回答