Javadoc没有为继承的方法生成注释

时间:2012-09-08 21:02:50

标签: java ant javadoc

我正在使用Ant来创建我的文档。我将{@inheritDoc}用于equalshashCodetoString等方法。但是,没有描述这些方法。见截图:

enter image description here

这是我的Ant脚本:

<project name="javadoc" default="javadoc.tool">
  <description>
    Provides JavaDoc. 
  </description>

  <import file="build.xml" />
  <property name="javadoc.dir" location="${build.dir}/javadoc" />
  <property name="javadoc.failonerror" value="false" />

  <target name="javadoc.tool" depends="compile" description="Generate JavaDoc.">
    <mkdir dir="${javadoc.dir}" />
    <javadoc classpathref="compile.classpath"
             sourcepath="${src.dir}"
             destdir="${javadoc.dir}"
             author="true"
             version="true"
             use="true"
             package="true"
             overview="${src.dir}/overview.html"
             windowtitle="${system.name} API"
             doctitle="${system.name} API"
             failonerror="${javadoc.failonerror}"
             excludepackagenames="junit"
             linksource="true" />
  </target>
</project>

如何获取要在文档中显示的继承方法的说明?非常感谢您的建议。谢谢!

2 个答案:

答案 0 :(得分:3)

如果您尝试从标准Ja​​va类继承文档,那么您需要在源路径中包含JDK src.zip(您可能还需要解压缩它;我不记得。)

那就是说,如果你的方法出现“意外”,你应该写自己的文档。如果他们不这样做,IMO你真的不需要他们的描述。

答案 1 :(得分:0)

我知道这是一个旧线程,但使用javadoc Ant任务链接到外部API的正确方法是使用嵌套的<link>元素。例如,要链接到Java 7 API:

<javadoc ... >
  ...
  <link href="http://docs.oracle.com/javase/7/docs/api/" />
</javadoc>

请阅读related Ant documentation了解所有详细信息。