Héctor Fuente Pérez

Este post pretende ser una guía muy sencilla para generar esta documentación desde Flex Builder. Para ello seguir los siguientes pasos:

1. Crear un nueva “External Tool”:

   - Click Run -> External Tools -> Open External Tools Dialog

   - Sobre el icono “Program” pulsamos con el botón derecho. Nos aparece “New” y los seleccionamos.




2. Introducimos el nombre que va tener asociada, en mi caso ASDOC.

3. En el campo “Location” debemos introducir la ruta al ejecutable asdoc. Para ello seleccionamos el botón “Browse File System” y navegamos por el arbol de directorios. Normalmente se encuentra en: C:\Archivos de programa\Adobe\Flex Builder 3 Plug-in\sdks\${version}\bin\asdoc.exe. En mi caso tengo varias sdks y selecciona la sdk 3.3.04589. Por tanto la ruta es C:\Archivos de programa\Adobe\Flex Builder 3 Plug-in\sdks\3.3.0.4589\bin\asdoc.exe.

4. Vamos asignar al campo “Working Directory” el valor ${project_loc}

5. Como argumentos: -source-path=./src -doc-sources=./src -window-title=”${project_name}” -main-title=”${project_name}” -external-library-path=./libs. Vemos que indicamos que el source path y los elementos sobre los que vamos a realizar el parseo se encuentran por debajo de la carpeta src y que las librerias externas que utiliza el proyecto se encuentran en la carpeta libs. Además indicamos que el titulo principal es el nombre del proyecto, así como el titulo de la ventana. Estos podemos modificarlo por ejemplo por   -window-title=”Documentación del proyecto ${project_name}”

6. Pulsamos sobre el botón “Apply”.




7. Por ultimo solo nos queda generar el ASDOC de un proyecto. Para ello pulsamos sobre el proyecto y ejecutamos la “External Tool” que hemos creado (Run->External Tools->ASDOC).




8. La documentación generada la deja en la carpeta  asdoc-output del proyecto. Para ver la documentación, basta con ejecutar el fichero index.html.
   
   
   

   En el siguiente link podeis ver la nomenclatura de asdoc: http://livedocs.adobe.com/flex/3/html/help.html?content=asdoc_3.html

   Existen otras formas de generarlo utilizando herramientas como Maven o Ant.

   - Maven (http://maven.servebox.org/sites/maven-flex-plugin/flex-plugin/asdoc-aggregate-mojo.html)

   - Ant (http://www.herrodius.com/blog/85)

   Salu2. Héctor