使用android studio在javadoc中链接本地图像

时间:2014-07-09 15:13:06

标签: java android android-studio javadoc

有没有办法在使用Android Studio的Android项目中的本地javadoc类中包含图像?

我想添加一个图表来阐明一个类的工作原理。 我的结构如下:

src/main/com.exampe.project/Class.java
docs/images/Diagram.png

现在我想将javadoc添加到类中,链接到Diagram.png

我的代码现在看起来像这样:

/**
 * <img src="docs/images/Diagram.png">
 */
public class Class {

但是,javadoc链接不起作用。有没有办法在javadoc中显示图像?

更新

显然,您可以使用docroot属性,但这不适用于当前版本的Android Studio。当我将javadoc更改为

/**
 * <a href="{@docRoot}docs/images/Diagram.png">link</a>
 */
public class Class {

并点击该链接,找不到该文件,因为它指向/Applications/Android Studio.app/bin/../../../../docs/images/Diagram.png。看来Android Studio会在程序的安装目录中搜索图像,而不是项目的根目录。 (这是在Mac上)

1 个答案:

答案 0 :(得分:1)

评论为:

/**
 * <img src="../../../images/Diagram.png"/>
 */

如果来源为CLASSPATH=src/main/且代码位于:
src/main/com/exampe/project/Class.java (3个目录后的java类)

doc/中的Java文档 docs/images/Diagram.png

然后java doc的输出在这里: docs/com/example/project/Class.html