ASDoc integration with build scripts

If you work in a team and use Flex, then you definitely use code written by other developers on your team. Wouldn’t it be nice to see the asdoc for their code the same way you see asdoc for the Flex SDK? Well now you no longer have to manually run asdoc, you can now leverage the <asdoc> ant task which is part of the Flex SDK.

The <asdoc> is available in the Flex 4 SDK only (not available in Flex 3). Nightly builds for the Flex 4 sdk can be downloaded from http://opensource.adobe.com/wiki/display/flexsdk/Download+Flex+4

Here is an sample asdoc target that can be used in ant build file.

<target name="asdocgen">
		<!-- for svn users the flexTasks.jar is
			under <sdk root>/lib -->
		<available property="flexTasksJar"
			value="${sdk.dir}/lib/flexTasks.jar"
			file="${sdk.dir}/lib/flexTasks.jar"/>

		<!-- for sdk package (zip) the flexTasks.jar is
			under <sdk root>/ant/lib -->
		<available property="flexTasksJar"
			value="${sdk.dir}/ant/lib/flexTasks.jar"
			file="${sdk.dir}/ant/lib/flexTasks.jar"/>

	    <property name="FLEX_HOME" value="${sdk.dir}" />	

		<asdoc output="${output.folder}/asdoc-output"
			main-title="My asdoc main title"
			footer="<u>My custom footer.</u>"
			window-title="Custom asdoc documentation"
			left-frameset-width="300"
			failonerror="true" fork="true">

			<packages.package name="com.test"
				description="description for com.test" />

			<!-- top level class to include in asdoc.
				These should be in the source-path (src1, src2) -->
			<doc-classes class="com.test.CustomMain"/>
			<doc-classes class="com.test.Foo"/>

			<!-- generate asdoc for all as/mxml files in the doc-sources -->
			<doc-sources path-element="${basedir}/src3"/>

			<!-- don't try to generate asdoc for
				includeFile.as (its an include file
				and can't be independently compiled -->
			<exclude-sources path-element="${basedir}/src3/includeFile.as"/>

			<!-- source path for asdoc -->
			<compiler.source-path path-element="${basedir}/src1"/>
			<compiler.source-path path-element="${basedir}/src2"/>

			<!-- namespaces to include in asdoc -->
			<doc-namespaces uri="http://www.gauravj.com/blog/"/>

			<!-- namespace declaration for asdoc -->
			<namespace uri="http://www.gauravj.com/blog/"
			manifest="${basedir}/manifest.xml"/>

			<jvmarg line="-Xmx512m"/>
		</asdoc>
	</target>

As you can see it supports all the options of command line asdoc (doc-classes, doc-sources, doc-namespaces, source-path, etc.). So you can now write ant targets for your asdoc generation.

If you face any issues or have any feedback, you can log bugs at http://bugs.adobe.com/flex