2016-12-30 31 views
1

我想通过一个小的测试项目生成一些javadoc,但我并不真正了解它的所有行为。似乎我的主要课程中的很多方法都被排除在外,我并没有真正明白为什么。为什么javadoc通过ant显示我的一些方法文档?

下面是一个例子:

/** 
* Diese Methode deligiert die Ausfuehrung der zustandsabhaengigen Aktion an die entsprechende Methode 
* des Zustandsobjektes weiter, welches gerade in der Objektvariable zustand gespeichert ist. 
* @see SetMinutes 
* @see SetHours 
* @see DisplayTime 
*/ 
void inc(){ 
    zustand = zustand.inc(this); 
} 

这一个未示出。我的ant目标看起来像这样:

<target name="doc" depends="generateJar"> 
    <javadoc destdir="${doc.dir}"> 
      <fileset dir="."/> 
    </javadoc> 
</target> 

正在显示的唯一的方法是在主方法(其被记录)和run()方法(空)。我最想知道的是,我在项目其他类中的方法文档生成正确,我看不出有什么不同。 (我也有生成一个字段摘要的问题,但这可能是另一个问题的东西,不是吗?)

任何帮助,将不胜感激。

回答

0

编辑:适合斯特凡Bodewigs评论。

随着吉姆·加里森的暗示我能够找出解决方案如下(我也会总结一下已经说有一个职位的所有内容):

  • 默认的命令行选项的javadoc被保护,它不会生成javadoc用于私有和包私有字段和方法
  • 如果希望通过ant自动执行此操作,我们可以使用 package =“true”(或private =“true”,如果希望包括那些领域和方法)

示例:

<target name="doc" depends="generateJar"> <!--default option für javadoc ist -protected (siehe Web) daher fliegen im default package private methoden raus aus der doc--> 
    <javadoc destdir="${doc.dir}" package="true"> 
      <fileset dir="."/> 
    </javadoc> 
</target> 
+1

实际上你不想使用'additionalparam',而是'package =“true”'。 –

+0

感谢您的补充!我会改变我的答案来适应这个! – Wolfone

+0

谢谢,看起来好多了。 –

相关问题