ASDoc mit Ant in FlexBuilder / Eclipse

/ Autor: Jürgen, 11 Jul 2008

Das Flex SDK stellt das Kommandozeilentool ASDoc zum automatischen Erstellen von Dokumentationen bereit. Mit ASDoc können einfach HTML-Dokumentationen zu einem bestehenden Flex Projekt erstellt werden, vorausgesetzt die ActionScript und MXML Files wurden nach den Standards kommentiert.

Um asdoc aufzurufen muss mit der Kommandozeile in den Flex SDK Ordner navigiert werden, und hier in den Ordner bin. Dann kann über die Zeile aufgerufen werden:

asdoc -source-path . -doc-classes comps.GraphingWdt comps.GraphingWtgTwo

Mehr Beispiele siehe Adobe Livedocs

Über ein kleines Ant Script das im FlexBuilder bzw. in Eclipse ausgeführt wird, kann dieser Prozess vereinfacht werden. Bei diesem Skript müssen lediglich die Variablen im oberen Bereich angepasst werden und ein Symlink zum flex sdk erstellt werden. Der Symlink ist nötig, da ASDoc nicht mit eventuellen Leerzeichen umgehen kann.

<?xml version="1.0"?>
<project name="ASDoc" default="asdocs">

	<!--
	Note that /flex_sdk/ is a symlink I setup to point to the actual
	Flex sdk install since there are issues with spaces in the
	command line arguments.
	-->

	<property name="PROJECT_DIR" value="path to project"/>
	<property name="FLEX" value="/flex_sdk"/>
	<property name="TEMPLATES" value="${FLEX}/asdoc/templates"/>
	<property name="DOC_SOURCE" value="${PROJECT_DIR}/src/de"/>
	<property name="LIB" value="${PROJECT_DIR}/libs"/>
	<property name="OUTPUT" value="${PROJECT_DIR}/docs"/>

	<!-- Creates the ASDoc and saves it in the specified
	Folder in the Project -->
	<target name="asdocs">

		<!-- Clean out the contents of the doc directory,
		without deleting "docs" -->
		<delete includeemptydirs="true">
			<fileset dir="${OUTPUT}" includes="**/*" />
		</delete>

		<exec executable='${FLEX}/bin/asdoc'>
			<arg line='-library-path ${FLEX}/frameworks/libs'/>
			<arg line='-library-path ${LIB}'/>
			<arg line='-doc-sources ${DOC_SOURCE}'/>
			<arg line='-output ${OUTPUT}'/>
			<arg line='-templates-path ${TEMPLATES}'/>
			<arg line='-source-path ${PROJECT_DIR}/src/'/>
		<arg line='-footer squareFACTOR'/>
		</exec>
	</target>
</project>

Nun müssen noch die folgenden Schritte ausgeführt werden:

1. Neues Projekt erstellen (So kann das Skript für mehrere Projekte verwendet werden)
2. build.xml einfügen (siehe Code oben) und Variablen anpassen
3. build.xml als Ant Build ausführen

Um ein Ant Script ausführen zu können muss im Flex Builder ein zusätzliches Apache Ant Support Plugin installiert werden, in Eclipse ist dieses schon standardmäßig vorhanden. Eine Anleitung zur Installation von Apache Ant gibt Peter Elst in seinem Blog.

This entry was posted on Freitag, Juli 11th, 2008 at 9:34 and is filed under ActionScript, Flex. You can follow any responses to this entry through the RSS 2.0 feed. You can leave a response, or trackback from your own site.