// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Gnration de la doc ActionScript
// Auteur : Mathieu BRUNOT
// Version : 1.1
// Date : 15 juin 2011
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// makeasdoc.bat


Le principe est le suivant : 
	- On dfinit le chemin vers asdoc.exe ;
	- On dfinit le fichier de config du projet.
		Par dfaut, on utilise %1\doc_config.xml (d'o l'utilit de bien 
		se positionner dans le dossier qui contient ce fichier) ;
	- On lance asdoc en lui passant le fichier de config du projet.


Si vous voulez intgrer ce batch  Eclipse/FB, voici mon conseil : 
	- Crer un dossier makeasdoc dans votre workspace ;
	- Placer ce fichier dans votre dossier makeasdoc ;
	- Dans Eclipse/FB : 
		. Sur l'icne Run External Tools (Bouton vert de lecture avec une
			valise en dessous), cliquer sur la flche puis sur
			Open External Tools Dialog ; 
		. (Nouvelle fentre) Dans la partie gauche, crer une nouvelle
			configuration de lancement (feuille avec un signe plus), 
			et l'appeler "Make ASDoc" (par exemple) ;
		. Configurer comme suit : 
			Location = ${workspace_loc}\makeasdoc\makeasdoc.bat
			Working Directory = ${project_loc}
		. Pour Arguments, si vous ne souhaitez pas mettre le fichier de 
			config dans la racine du projet, mettre le chemin du dossier
			que vous souhaitez utiliser POUR TOUS LES PROJETS
			(chemin relatif au projet : ${project_loc}\)
		. Slectionner un projet et lancer "Make ASDoc" ;

Le prompt d'asdoc s'affichera dans la console d'Eclipse/FB et les erreurs 
seront affiches en rouge.

Sympa, non ;) ?


// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// asdoc_config.xml

Le fichier de config est au format suivant (xml) : 
<flex-config>
	<compiler>
		<source-path>
			<path-element>.</path-element> <!-- Chemin sources -->
		</source-path>
		<namespaces>
			<namespace>
				<uri>http://myURL.com</uri> <!-- Namespace -->
				<manifest>asdoc_manifest.xml</manifest> <!-- manifest file -->
			</namespace>
		</namespaces>
	</compiler>
	
	<main-title>myMainDocTitle</main-title> <!--  Titre de la doc -->
	<window-title>myBrowserWindowTitle</window-title> <!--  Titre du header du navigateur -->
	<footer>myFooterText</footer> <!-- Pied de page -->
	<output>myAsdocOutput</output> <!-- Dossier de sortie -->
	<doc-doc-namespaces>
		<uri>http://myURL.com</uri> <!-- Namespace  inclure -->
	</doc-doc-namespaces>
	
	<packages> <!-- Inclusion de description de packages intgrs -->
		<package>
			<string>package.name</string>
			<string>myPackageDescription</string>
		</package>
	</packages>
	
	<metadata> <!-- Les metadata  inclure -->
		<title>myFreamWorkDocumentationTitle</title>
		<description>myFreamWorkDocumentationDescription</description>
		<publisher>publisher</publisher>
		<creator>creator</creator>
		<language>EN</language>
	</metadata>
	
</flex-config>


// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// asdoc_manifest.xml

Le fichier de manifest est au format suivant (xml) : 
<componentPackage>
	<component id="ClassName" class="package.ClassName"/>
	<!-- ... -->
</componentPackage>


// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Sources

Bas sur les tutoriels trouvs aux adresses ci-dessous : 
http://wiki.flexx.fr/doku.php?id=tutoriaux:flex:asdoc
http://sebleedelisle.com/2009/03/how-to-set-up-asdoc-in-flex-builder/

Pour plus d'informations sur asdoc :
http://livedocs.adobe.com/flex/3/html/help.html?content=asdoc_1.html
http://opensource.adobe.com/wiki/display/flexsdk/ASDoc+in+MXML
http://ressources.mediabox.fr/documentation/flash/asdoc/creer_des_commentaires


// End of File ~~~~~~~~~~~~~~~~~~~~~~~~~
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~