使用ANT从Javadoc生成排除某些源文件 [英] Excluding some source files from javadoc generation using ANT

问题描述

  

可能重复：结果
  <一href=\"http://stackoverflow.com/questions/6060998/how-can-i-make-an-ant-javadoc-class-exclude-two-files\">How我可以做一个Ant的Javadoc类排除两个文件？

我要排除Javadoc生成一些日食相关的文件，比如 Activator.java 从我的蚂蚁的javadoc目标。我有我的code的下面的示例这对于下一个文档不同的Java项目生成javadoc的。

 ＆LT;项目的basedir =。默认值为jdocNAME =ANT_TASK＆GT;
＆lt;目标描述=创建为XXXXX模块的JavadocNAME =jdoc＆GT;
      ＆LT;的javadoc
               DESTDIR =文档/ API
               使用=真
               公共=真
               splitindex =真
               CLASSPATH =.. \\ com.sample.script.modules \\ BIN
               packagenames =com.sample.package1，
                             com.sample.test1
               WINDOWTITLE =XXXXX 1.0 API＆GT;
        ＆LT;＆源路径GT;
              ＆LT; pathelement路径=.. \\ com.sample.package的\\ src/＆GT;
              ＆LT; pathelement路径=.. \\ com.sample.test的\\ src/＆GT;
        ＆LT; /源路径＆GT;
        ＆LT; doctitle＆GT;＆LT;！[CDATA [＆LT; H1＆GT; XXXXX 1.0 API＆LT; / H1＆GT;]]＆GT;＆LT; / doctitle＆GT;
        ＆LT;＆底部GT;＆LT;！[CDATA [＆LT; I＆GT;版权和放大器;＃169; 1999-2012 XXXX有限公司版权所有＆LT; / I＆GT;]]＆GT;＆LT; /底部＆GT;
      ＆LT; / javadoc的＆GT;
＆LT; /目标与GT;
＆LT; /项目＆GT;
 

谁能帮我，我应该怎么排除Javadoc生成的 Activator.java 文件。

解决方案

直接从javadoc的蚂蚁任务：

  

 ＆LT;文件集DIR =SRCdefaultexcludes =YES＆GT;
  ＆LT;包括姓名=COM /虚拟/测试/ **/＆GT;
  ＆LT;排除NAME =COM /虚拟/测试/文档文件/ **/＆GT;
＆LT; /文件集＆GT;＆所述; doctitle＆GT;＆下;！[CDATA并[d H1＆GT;试验＆下; / H1]的计算值]≥＆下; / doctitle＆GT;
＆LT;＆底部GT;＆LT;！[CDATA [＆LT; I＆GT;版权和放大器;＃169; 2000虚拟Corp.保留所有权利＆LT; / I＆GT;]]＆GT;＆LT; /底部＆GT;
＆LT;标签名称=待办事项范围=所有描述=要做到：/＆GT;
＆LT;组标题=1组包套餐=com.dummy.test.a */＆GT;
＆LT;组标题=2组包套餐=com.dummy.test.b *：* com.dummy.test.c/＆GT;
＆LT;链接下线=真HREF =htt​​p://download.oracle.com/javase/6/docs/api/packagelistLoc =C：\\ tmp目录/＆GT;
＆LT;链接HREF =htt​​p://developer.java.sun.com/developer/products/xml/docs/api//＆GT;
 

所以，我将会把文件POU到文件集的排除列表。

Possible Duplicate:
How can I make an Ant Javadoc class exclude two files?

I want to exclude javadoc generation for some eclipse related files, say Activator.java from my ant javadoc target. I have my below sample of code which generates javadoc for different java projects under single document.

<project basedir="." default="jdoc" name="ANT_TASK">
<target description="creates the javadoc for the XXXXX module" name="jdoc">
      <javadoc
               destdir="docs/api"
               use="true"
               public="true"
               splitindex="true"
               classpath="..\com.sample.script.modules\bin"
               packagenames="com.sample.package1,
                             com.sample.test1"
               windowtitle="XXXXX 1.0 API"> 
        <sourcepath>
              <pathelement path="..\com.sample.package\src"/>
              <pathelement path="..\com.sample.test\src"/>        
        </sourcepath>
        <doctitle><![CDATA[<h1>XXXXX 1.0 API</h1>]]></doctitle>
        <bottom><![CDATA[<i>Copyright &#169; 1999-2012 XXXX company Ltd. All Rights Reserved.</i>]]></bottom>
      </javadoc>
</target>
</project>

Can anyone help me how should I exclude the Activator.java file from javadoc generation.

解决方案

Straight from the javadoc ant task:

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

<doctitle><![CDATA[<h1>Test</h1>]]></doctitle>
<bottom><![CDATA[<i>Copyright &#169; 2000 Dummy Corp. All Rights Reserved.</i>]]></bottom>
<tag name="todo" scope="all" description="To do:"/>
<group title="Group 1 Packages" packages="com.dummy.test.a*"/>
<group title="Group 2 Packages" packages="com.dummy.test.b*:com.dummy.test.c*"/>
<link offline="true" href="http://download.oracle.com/javase/6/docs/api/" packagelistLoc="C:\tmp"/>
<link href="http://developer.java.sun.com/developer/products/xml/docs/api/"/>

So I would pou the file into the exclude list of the fileset.

这篇关于使用ANT从Javadoc生成排除某些源文件的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！