Question

我正在记录一些Java Web服务和支持数据类型。我不想记录两种服务。从Ant javadoc任务中排除少量文件的正确方法是什么？

我尝试使用嵌套在sourcepath或sourcefiles下的文件或文件集进行多次迭代，并使用include和exclude的各种组合。

我已正确定义的基本目标记录了我的所有网络服务：

    <target name="javadoc.webservices" description="Generate the documentation for companyproject webservices">
    <delete dir="docs/webservices" failonerror="true"/>
    <mkdir dir="docs/webservices"/>
    <javadoc packagenames="com.company.project.webservices,com.company.project.models.*"
             defaultexcludes="yes"
             destdir="docs/webservices"
             author="true"
             version="true"
             use="true"
             windowtitle="company project Webservices">
        <doctitle><![CDATA[<h1>company project Webservices</h1>]]></doctitle>
        <bottom><![CDATA[<i>Copyright &#169; 2011 company Corp. All Rights Reserved.</i>]]></bottom>
        <sourcepath>
            <path location="companyproject-ejb/src/java"/>
            <path location="companyproject-models/src"/>
        </sourcepath>
        <classpath>
            <path refid="companyproject-models.module.classpath"/>
            <path refid="companyproject-ejb.module.classpath"/>
            <pathelement location="${companyproject-ejb.output.dir}"/>
        </classpath>
    </javadoc>
</target>

我尝试过的一些变化包括：

<sourcefiles>
            <fileset dir="companyproject-ejb/src/java">
                <include name="**/*.java"/>
                <exclude name="**/*IntegrationTestWS*, **/*NhinInterfaceWS*"/>
            </fileset>
        </sourcefiles>

javadoc.exe CreateProcess error=87, The parameter is incorrect

出现此错误

<sourcepath>
            <fileset dir="companyproject-ejb/src/java">
                <include name="**/*.java"/>
                <exclude name="**/*IntegrationTestWS*, **/*NhinInterfaceWS*"/>
            </fileset>
        </sourcepath>

与sourcefiles相同的错误，但有很多消息说skipping <somefile> since it is no directory。

我使用<files>代替<fileset>尝试了类似的变体。

我认为我缺少对包含/排除作品的基本理解。谢谢你的帮助！

AlexR并没有完全明白，但接近了。我删除了<sourcepath>并添加了

<fileset dir="./Companyproject-ejb/src/java/">
<include name="com/Company/project/webservices/*"/>
<exclude name="**/IntegrationTestWS*"/>
<exclude name="**/NhinInterfaceWS*"/>
</fileset>
<packageset dir="./Companyproject-models/src/">
    <include name="com/Company/project/models/**"/>
</packageset>

只有一个文件集导致javadoc抱怨它找不到任何软件包。 Packageset的行为类似于dirset，因此它不能排除单个文件，只能排除目录。在这种情况下，我能够为一组doco定义一个packageset，为限制集定义一个文件集，然后绕过它。

Answer 1

<fileset dir="src" defaultexcludes="yes">
  <include name="com/dummy/test/**"/>
  <exclude name="com/dummy/test/doc-files/**"/>
</fileset>

..................

我认为你的错误是“sourcefiles”和“sourcepath”标签。尝试删除它们。有关详细信息，请查看此处：http://ant.apache.org/manual/Tasks/javadoc.html

祝你好运！

Answer 2

刚刚遇到同样的问题，并在man javadoc中挖掘了一点，得出的结论是没有解决方案，除了碰巧在OPs情况下工作的解决方法。但我想记录我从文档中读到的内容。

Ant的javadoc任务只是Java javadoc的包装器，所以后者的文档适用。特别是，javadoc似乎有两个完全分离的生成文档的概念：

文件包
记录个别课程

对于（1），我们指定包名称，如my.nice.package和-sourcepath，以帮助javadoc找到这些包。使用ant，名称可以packagenames或packageset提供，后者将路径名转换为包名（斜杠到点）。

对于（2）我们指定文件路径，可能使用通配符。然后记录每个单独的文件。使用ant，这是通过嵌套的fileset完成的，它允许我们排除文件。

现在似乎有两件事在javadoc中没有很好地发挥作用。

a）记录包时，无法排除单个文件。

b）在记录单个文件时，不会记录包，这会导致在使用{@link my.package}时出现有关包名称错误引用的错误消息。

在man javadoc中搜索记录包和类，以查看我在这里阅读的内容。

这是decade old problem，似乎： - （

如何让Ant Javadoc类排除两个文件？

2 个答案: