Commandes ASDoc

Ce tableau des commandes ASDoc fait partie du tutorial Compiler sa documentation ASDoc

Option	Description
`-doc-classes`	Défini une liste de classes à compiler. Cette option nécessite la définition de l'option -source-path. `asdoc -source-path C:\flex\frameworks\projects\framework\src -doc-classes mx.controls.Button mx.controls.ButtonBar`
`-examples-path`	Non documenté dans Flex ni dans -help-list, Mais est necessaire pour inclure des exemples en fichiers externe. En général, est défini de manière identique à -source-path à condition de placer les .as d'exemples à coté de la classe concernée.
`-doc-sources`	Défini une liste de chemins de classes à compiler. Si cette option est définie sans nom de fichier, c'est toutes les classes du répertoire qui seront compilées, ainsi que celles des sous répertoires. `asdoc -doc-sources C:\flex\frameworks\projects\framework\src\mx\controls\Button.as` `asdoc -doc-sources C:\flex\frameworks\projects\framework\src\mx\controls`
`-exclude-classes`	Défini une liste des classes à exclure de la compilation. Aternativement, vous pouvez baliser vos classes à @private afin de les exclure. `-exclude-classes comps.PageWidget comps.ScreenWidget`
`-exclude-dependencies true\|false`	Active ou désactive la compilation des classes utilisateur dépendantes. C'est à dire, les classes importées. La valeur par défaut est `false`. `asdoc -source-path C:\flex\frameworks\projects\framework\src -doc-classes mx.controls.Button -output framework-asdoc -exclude-dependencies=true`
`-footer`	Défini le texte qui apparait dans le footer de la documentation.
`-left-frameset-width`	Défini la taille en pixels des Frames Packages List et Classes List La valeur par défaut est 210 pixels.
`-main-title`	Défini le titre qui apparait dans l'entête de la documentation La valeur par défaut est "`API Documentation`".
`-output`	Défini le chemin et le répertoire dans lequel la documentation sera générée. La valeur par défaut est "`asdoc-output`". `asdoc -doc-sources C:\flex\frameworks\projects\framework\src\mx\controls\Button.as -output framework-asdoc`
`-package name "description"`	Ajoute une définition sur les packages utilisés. Vous pouvez ajouter plusieurs définitions. L'exemple suivant ajoute 2 définitions de packages à la documentation: `asdoc -doc-sources my_dir` `-output myDoc` `-package com.my.business "Contains business classes and interfaces"` `-package com.my.commands "Contains command base classes and interfaces"`
`-templates-path string`	Défini le chemin du Template que ASDoc doit utiliser pour la compilation. La valeur par défaut est: asdoc/templates.
`-window-title "string"`	Défini le titre de la page HTML, ce qui apparait dans la fenêtre du browser. La valeur par défaut est "`API Documentation`".