<?xml version="1.0" encoding="UTF-8"?>
<rss version="2.0"
	xmlns:content="http://purl.org/rss/1.0/modules/content/"
	xmlns:wfw="http://wellformedweb.org/CommentAPI/"
	xmlns:dc="http://purl.org/dc/elements/1.1/"
	xmlns:atom="http://www.w3.org/2005/Atom"
	xmlns:sy="http://purl.org/rss/1.0/modules/syndication/"
	xmlns:slash="http://purl.org/rss/1.0/modules/slash/"
	>

<channel>
	<title>DaveOnCode &#187; documentation</title>
	<atom:link href="http://www.daveoncode.com/tag/documentation/feed/" rel="self" type="application/rss+xml" />
	<link>http://www.daveoncode.com</link>
	<description>Objective C, iOS and more programming stuff</description>
	<lastBuildDate>Mon, 19 Dec 2011 12:11:12 +0000</lastBuildDate>
	<language>en</language>
	<sy:updatePeriod>hourly</sy:updatePeriod>
	<sy:updateFrequency>1</sy:updateFrequency>
	<generator>http://wordpress.org/?v=3.3.1</generator>
		<item>
		<title>Documenting Actionscript classes which make use of AIR framework</title>
		<link>http://www.daveoncode.com/2009/05/04/documenting-actionscript-classes-which-make-use-of-air-framework/</link>
		<comments>http://www.daveoncode.com/2009/05/04/documenting-actionscript-classes-which-make-use-of-air-framework/#comments</comments>
		<pubDate>Mon, 04 May 2009 21:57:09 +0000</pubDate>
		<dc:creator>Davide Zanotti</dc:creator>
				<category><![CDATA[actionscript]]></category>
		<category><![CDATA[air]]></category>
		<category><![CDATA[asdoc]]></category>
		<category><![CDATA[documentation]]></category>

		<guid isPermaLink="false">http://www.daveoncode.com/?p=392</guid>
		<description><![CDATA[This is just a quick post that may (I hope) help who are going to use asdoc tool to generate Actionscript documentation for AS classes which use AIR framework. Problem: You want to generate documentation for your package(s), but when you type asdoc command in the terminal you get a lot of errors such: Type [...]<div class="addthis_toolbox addthis_default_style addthis_32x32_style" addthis:url='http://www.daveoncode.com/2009/05/04/documenting-actionscript-classes-which-make-use-of-air-framework/' addthis:title='Documenting Actionscript classes which make use of AIR framework ' ><a class="addthis_button_preferred_1"></a><a class="addthis_button_preferred_2"></a><a class="addthis_button_preferred_3"></a><a class="addthis_button_preferred_4"></a><a class="addthis_button_compact"></a></div>]]></description>
			<content:encoded><![CDATA[<p>This is just a quick post that may (I hope) help who are going to use asdoc tool to generate Actionscript documentation for AS classes which use AIR framework.</p>
<p><strong>Problem:</strong></p>
<p>You want to generate documentation for your package(s), but when you type asdoc command in the terminal you get a lot of errors such:</p>
<p><em>Type was not found or was not a compile-time constant: File.</em><br />
<em>Type was not found or was not a compile-time constant: Vector</em></p>
<p>&#8230;and so on</p>
<p><strong>Solution:</strong></p>
<p>You have to use <strong>-external-library-path</strong> option to include AIR swc, because AIR classes are located into external swc apart from Flex framework.<br />
These files are under /sdks/{yourSDKVersion}/frameworks/libs/air/ (where &#8220;{yourSDKVersion}&#8221; is the version of Flex SDK you are using to deploy your applications) and are the following five:</p>
<ul>
<li>airframework.swc</li>
<li>airglobal.swc</li>
<li>applicationupdater_ui.swc</li>
<li>applicationupdater.swc</li>
<li>servicemonitor.swc</li>
</ul>
<p>The first 2 should be imported with <strong>-external-library-path</strong> option anytime you use AIR classes, the others are necessary only if you are using the update framework and/or serivicemonitor.</p>
<p>The following is an example of how to use the asdoc command with the option discussed:</p>
<p><em><br />
./asdoc -source-path=/Users/davidezanotti/Documents/workspace/myproject/src/ -external-library-path=/Applications/Adobe\ Flex\ Builder\ 3\ Plug-in/sdks/3.3.0.4589/frameworks/libs/air/airframework.swc,/Applications/Adobe\ Flex\ Builder\ 3\ Plug-in/sdks/3.3.0.4589/frameworks/libs/air/airglobal.swc -doc-sources=/Users/davidezanotti/Documents/workspace/myproject/src/ -output=/Users/davidezanotti/Desktop/doc</em>
</p>
<p>The code above will succesfull generate documentation for all classes under the folder &#8220;/Users/davidezanotti/Documents/workspace/myproject/src/&#8221; to the &#8220;doc&#8221; folder on the desktop.</p>
<div class="addthis_toolbox addthis_default_style addthis_32x32_style" addthis:url='http://www.daveoncode.com/2009/05/04/documenting-actionscript-classes-which-make-use-of-air-framework/' addthis:title='Documenting Actionscript classes which make use of AIR framework ' ><a class="addthis_button_preferred_1"></a><a class="addthis_button_preferred_2"></a><a class="addthis_button_preferred_3"></a><a class="addthis_button_preferred_4"></a><a class="addthis_button_compact"></a></div>]]></content:encoded>
			<wfw:commentRss>http://www.daveoncode.com/2009/05/04/documenting-actionscript-classes-which-make-use-of-air-framework/feed/</wfw:commentRss>
		<slash:comments>0</slash:comments>
		</item>
	</channel>
</rss>

