Puis-je utiliser DoxyGen pour documenter du code ActionScript? [fermé]

Question

Comment configurer DoxyGen pour documenter des fichiers ActionScript?

J'ai inclus les fichiers * .as et * .asi dans le modèle de recherche de doxygen, mais les classes, les fonctions et les variables ne s'affichent pas.

Answer 1

Au lieu de doxygen, vous devez utiliser un générateur de documentation prenant spécifiquement en charge le langage. Pour ActionScript 2, vous avez plusieurs choix:

1. NaturalDocs ( exemple ) (gratuit)
2. ZenDoc (gratuit)
3. AS2Doc Pro ( exemple ) (commercial)

Si vous utilisez ActionScript 3, Adobe inclut un générateur de documentation gratuit avec son compilateur open source (le SDK Flex ), appelé" ASDoc " ;. Si vous utilisez FlashDevelop , le la dernière version bêta a une interface graphique intégrée pour exécuter ASDoc. Vous n'avez donc pas à vous salir les mains. avec la ligne de commande.

Answer 2

J'ai pu produire une documentation avec DoxyGen (que puis-je dire - j'aime ses fonctionnalités et ses fonctionnalités) en procédant comme suit:

Ajoutez les fichiers * .as et * .asi à la liste des types de fichiers à saisir.

Sélectionnez:

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

Un autre problème dans AS3 est la déclaration de package. Vous devez indiquer à DoxyGen d’ignorer la définition du package. C'est facile à faire en utilisant cond. Donc, vous allez changer la ligne:

package myPackage {

dans

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

Ce qui fera que Doxygen ignore les lignes entre cond et endcond. Notez qu'il semble inutile de faire la même chose pour l'accolade fermante située au bas de votre fichier .as.

Answer 3

Vous pouvez également utiliser Ortelius. Il est plus facile à utiliser que ASDoc car il est livré avec une interface graphique simple, et il est plus pardonné à votre code. C'est gratuit et opensource, mais uniquement sous Windows.

ortelius.marten.dk