Javadoc不为继承的方法生成注释
我正在使用Ant创建文档。我使用了Javadoc不为继承的方法生成注释,java,ant,javadoc,Java,Ant,Javadoc,我正在使用Ant创建文档。我使用了{@inheritDoc}方法,例如equals,hashCode,和toString。但是,没有显示这些方法的描述。请参见屏幕截图: 这是我的Ant脚本: <project name="javadoc" default="javadoc.tool"> <description> Provides JavaDoc. </description> <import file="build.xml"
{@inheritDoc}
方法,例如equals
,hashCode
,和toString
。但是,没有显示这些方法的描述。请参见屏幕截图:
这是我的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>
提供JavaDoc。
如何获取文档中显示的继承方法的描述?非常感谢你的建议。谢谢 如果您试图从标准Java类继承文档,那么我认为您需要在sourcepath中包含JDK
src.zip
。(您可能还需要解压;我不记得了。)
这就是说,如果您的方法出现了“意外”情况,您应该编写自己的文档。如果没有,在我看来,你并不真正需要对它们的描述。我知道这是一个旧线程,但是通过javadoc Ant任务链接到外部API的正确方法是使用嵌套的
元素。例如,要链接到Java 7 API:
<javadoc ... >
...
<link href="http://docs.oracle.com/javase/7/docs/api/" />
</javadoc>
...
有关所有详细信息,请阅读。使用Oracle JDK 1.7,将
src.zip
指定为sourcepath
由于错误而失败。解压src.zip
有效,尽管有2705条警告。@cpeister可能有关于内部类的警告;我没试过。