使用只包含所需的类的ASDoc

如果你使用asdoc且只想包含具体的包，如去除你使用的开源类库，你可以编写如下的ANT脚本（摘自这篇文章）

• <?xml version="1.0" encoding="UTF-8"?>
• <project name="Labstr" default="asdoc" basedir=".">
• <!-- 电脑上的特定的配置文件 -->
•     <property file="local.properties" />
•     <target name="asdoc">
• <!-- 在docs文档放进项目根目录下的docs文件夹内 -->
•         <delete dir="${basedir}/docs"/>
•         <mkdir dir="${basedir}/docs"/>
• <!-- 获取你不希望在docs文件夹内的文件列表，即除了那些你需要的所有文件 -->
•         <fileset id="sources" dir="${basedir}/src">
•             <exclude name="**/your/package/name/**"/>
•         </fileset>
• <!-- 替换文件名为完全合格的类名 -->
•             <pathconvert property="classes" pathsep=" " refid="sources">
• <!-- ChainedMapper逐次运行它的子mapper -->
•                 <chainedmapper>
• <!-- 基础或应射windows和mac的斜线，删除我们不需要的完整路径的部分 -->
•                     <mapper>
•                         <globmapper from="${basedir}/src/*" to="*" />
•                         <globmapper from="${basedir}/src/*" to="*" />
•                     </mapper>
• <!-- 替换文件路径为类名 -->
•                     <mapper type="package" from="*.as" to="*" />
•                 </chainedmapper>
•             </pathconvert>
• <!-- 运行asdoc -->
•         <exec executable="${ASDOC}" dir="${basedir}">
•             <arg line="-source-path ${basedir}/src
•                        -doc-sources ${basedir}/src
•                        -exclude-classes ${classes}
•                        -output docs"/>
•         </exec>
•     </target>
• </project>

复制代码

我的local.properties文件的内容如下：

• FLEX_HOME=e:/work/4.5.0
• ASDOC=${FLEX_HOME}/bin/asdoc.exe

复制代码