如何从javadoc中排除某些类/包/公共成员

时间:2009-02-26 20:31:18

标签: c# java eclipse javadoc

我已经创建了来自C#的java api -ported更具体 - 除了公共接口之外,还包含很多我不希望用户知道的内部内容。在C#中,我使用doxygen来生成文档。我认为javadoc具有类似的功能,可以排除某些公共成员,类,甚至包。

有人会建议怎么做,也许是通过eclipse?

由于

3 个答案:

答案 0 :(得分:2)

我相信在Eclipse中,您可以指定的唯一类型的排除项是“排除所有受保护的成员”和基于包的排除项(不是基于类的排除项)。

如果您使用Ant生成它们,则可以使用嵌套的“package”元素,并且可以使用文件集嵌套元素并向该文件集添加排除项。

例如:

<javadoc >
    <sourcefiles>
          <fileset dir="${src}">
              <include name="**/*.java"/>
              <exclude name="**/ClassToExclude.java"/>
          </fileset>
    </sourcefiles>
    <packageset>
          <dirset dir="${src}">
              <include name="com.mydomain.*"/>
              <exclude name="com.mydomain.excludePackage"/>
          </dirset>
     </packageset>
</javadoc>

P.S。 - 我使用了<sourcefiles>元素,但从未使用<packageset>元素。后者可能不是语法上的点。

答案 1 :(得分:1)

当然,当您“生成Javadoc”时,您可以选择此过程涉及的包并排除其他包

alt text http://www.filigris.com/products/docflex_javadoc/images/eclipse_javadoc_1.png

(这里的图片显示了使用其他工具生成的javadoc,但这并没有改变一般的想法)

答案 2 :(得分:0)

您可以在Java中使用doxygen。我不知道有任何工具可以用Javadoc做你想要的。

Superpackages应该是JDK 7,我相信可以解决这个问题:http://blogs.oracle.com/andreas/entry/superpackages_in_jsr_294