¿Puedo usar DoxyGen para documentar el código ActionScript? [cerrado]

Question

¿Cómo configuro DoxyGen para documentar archivos ActionScript?

He incluido los archivos * .as y * .asi en el patrón de búsqueda de doxygen, pero las clases, funciones y variables no se muestran allí.

Answer 1

En lugar de doxygen, debe usar un generador de documentación que admita específicamente el idioma. Para ActionScript 2, tiene un par de opciones:

1. NaturalDocs ( ejemplo ) (gratis)
2. ZenDoc (gratis)
3. AS2Doc Pro ( ejemplo ) (comercial)

Si está utilizando ActionScript 3, Adobe incluye un generador de documentación gratuito junto con su compilador de código abierto (el Flex SDK ), llamado " ASDoc " ;. Si está utilizando FlashDevelop , el última versión beta tiene una GUI integrada para ejecutar ASDoc, para que no tenga que ensuciarse las manos con la línea de comando.

Answer 2

He podido producir ALGUNA documentación con DoxyGen (¿Qué puedo decir? Me gustan sus características y capacidades) Al hacer lo siguiente:

Agregue * .as y * .asi a la lista de tipos de archivos para ingresar.

Seleccionar:

OPTIMIZE_OUTPUT_JAVA   = YES
EXTRACT_ALL            = YES
HIDE_UNDOC_MEMBERS     = NO
HIDE_UNDOC_CLASSES     = NO

Otro problema en AS3 es la declaración del paquete. Debe decirle a DoxyGen que ignore la definición del paquete. Esto es fácil de hacer usando cond. Entonces cambiará la línea:

package myPackage {

en

/// @cond
package myPackage {
/// @endcond

Lo que hará que Doxygen ignore las líneas entre cond y endcond. Tenga en cuenta que parece que no hay necesidad de hacer lo mismo para el cierre de llaves en la parte inferior de su archivo .as.

Answer 3

También puedes usar Ortelius. Es más fácil de usar que ASDoc, ya que viene con una GUI simple y es más indulgente con su código. Es gratis y de código abierto, pero solo para ventanas.

ortelius.marten.dk