Javadoc和maven:当指向另一个jar时,使类引用可单击

时间:2018-06-07 16:54:15

标签: java maven javadoc maven-javadoc-plugin

我有两个罐子,一个用于接口,一个用于实现。 例如,在第一个罐子里我有:

package com.myapp.jar1
public inteface MyInterface {...}

在我的第二个罐子里

package com.myapp.jar2
import com.myapp.jar1.MyInterface

public class MyClass implements MyInterface {...}

当通过maven创建javadoc时,对同一包中的类的引用将在链接中转换(按预期方式),而对另一个包中的类的引用是简单文本。

我想问题是javadoc不知道MyInterface在哪里和谁。

是否存在通知javadoc在其他软件包中检查doc的方法?

详细信息:

在Apache中我有一个目录javadoc,我在那里解压缩所有的罐子:

/var/www/html/javadoc/jar1
/var/www/html/javadoc/jar2

所以我的链接指向同一服务器中的另一个位置或外部资源,如果是第三个产生的包(例如Jackson)

1 个答案:

答案 0 :(得分:0)

以这种方式使用javadoc查找其他包

{@link [<package>.]<class>[#<method>] label}
{@link [<package>.]<class>[#<method>]}
{@link #<method>}

示例:

{@link com.project.Interfaces.MyInterface MyInterface}

如果您想要显示完整路径,请不要使用标签。

另一个 .jar 中的Javadoc:

  1. 右键点击项目:
  2. 构建路径&gt;配置构建路径
  3. 图书馆&gt;选择库并展开它
  4. 选择&#34; Javadoc位置&#34; &GT;点击&#34;编辑&#34;右边的按钮。
  5. 使用docs
  6. 添加jar文件
  7. 点击&#34;验证&#34;按钮检查是否有任何问题
  8. jar 它是 zip 文件的重命名扩展,需要在根目录中有index.html

    参考文献: