Posso usar Doxygen para documentar o código do ActionScript? [fechadas]

Question

Como posso Configurando Doxygen para documentar arquivos do ActionScript?

Eu incluí os .as * e * arquivos .asi em padrão de pesquisa do doxygen, mas as classes, funções e variáveis ??não mostram lá.

Answer 1

Em vez de doxygen você deve usar um gerador de documentação que suporta especificamente a linguagem. Para ActionScript 2, você tem algumas opções:

1. NaturalDocs ( exemplo ) (livre)
2. ZenDoc (livre)
3. AS2Doc Pro ( exemplo ) (comercial)

Se você estiver usando ActionScript 3, a Adobe inclui um gerador de documentação livre junto com seu compilador open source (o Flex SDK ), chamado " ASDoc ". Se você estiver usando FlashDevelop , a última versão beta foi construído em um GUI para executar ASDoc, para que você não tem que sujar as suas mãos com a linha de comando.

Answer 2

Eu tenho sido capaz de produzir alguma documentação com Doxygen (O que posso dizer - eu como suas características e capacidades), fazendo o seguinte:

Adicionar .as * e * .asi à lista de tipos de arquivos de entrada.

Selecionar:

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

Outra questão em AS3 é a declaração pacote. Você precisa dizer Doxygen para ignorar a definição do pacote. Isso é fácil de fazer usando cond. Então você vai mudar a linha:

package myPackage {

para

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

O que fará com que Doxygen para ignorar a linha (s) entre cond e endcond. Nota que parece haver nenhuma necessidade de fazer o mesmo para o suporte de fechamento na parte inferior do seu arquivo .as.

Answer 3

Você também pode usar Ortelius. É mais fácil de usar do que ASDoc uma vez que vem com um simples GUI, e seu mais perdoado ao seu código. Sua livre e de código aberto, mas somente para Windows.

ortelius.marten.dk