When you specify a class by using the exclude-sources option, the class is not even compiled. You can specify more than one package option. In the previous example, the output directory is named framework-output relative to the current working directory. You can combine the doc-sources and doc-classes options to specify the input to the ASDoc tool, as the following example shows: asdoc -source-path C:\flex\frameworks\projects\framework\src -doc-classes mx.controls.Button mx.controls.ButtonBar -doc-sources C:\flex\frameworks\projects\framework\src\mx\validators -output framework-asdoc navigate here
Please see C:\flex\bin\framework-asdoc\validation_errors.log for details. You can use a manifest file as input to the ASDoc tool to specify the input file list as the following example shows: asdoc -source-path C:\a\flex\flex\sdk\frameworks\projects\framework\src -doc-classes FrameworkClasses -namespace http://www.adobe.com/2006/mxml C:\flex\sdk\frameworks\projects\framework\manifest.xml For example, you specify the examples-path as c:\myExamples. These files are used by Adobe® Flash® Builder™ to show code hints and documentation.
The value to the doc-classes option is a space delimited list of input files that use dot notation to specify the package name of each class. Documentation was created in C:\flex\bin\framework-asdoc\ Using a configuration file with the ASDoc toolDepending on the number of input files, the input specification to the ASDoc tool can get complex. The configuration file is an XML file that lets you specify the command-line arguments to the tool in a file.
For more information on mxmlc, see Flex compilers. If you run the ASDoc tool with the keep-xml and skip-xsl options set to true, the XML files are retained. For more information, see Using compc, the component compiler. -doc-namespaces uri manifest A list of URIs to document. The default value is false. -left-frameset-width int An integer that changes the width of the left frameset of the documentation.
The following table lists the command-line options specific to the asdoc tool: Option Description -doc-classes path-element [...] A list of classes to document. The following example generates ASDoc content only for the Button class: asdoc -source-path C:\flex\frameworks\projects\framework\src -doc-classes mx.controls.Button -output framework-asdoc -exclude-dependencies=true Setting the exclude-dependencies option to true improves the performance of the ASDoc By default, the ASDoc tool writes these XML files to the tempdita directory in the output directory of your build. http://stackoverflow.com/questions/20531480/why-wont-asdoc-generate If true, the dependencies of the input classes are not documented.
Encountered not well-formed text. You can want to look at this file for an example of the types of information that you can write to a configuration file. If you specify a directory, the ASDoc tool generates output for all files in the specified directory and any subdirectories. The default is the asdoc/templates directory in the ASDoc installation directory.
Normally, these intermediate XML files are deleted when the ASDoc tool completes. The previous example uses the load-config option to specify the name of the configuration file. For more information, see Using compc, the component compiler. -examples-path path-element Specifies the location of the include examples used by the @includeExample tag. The ASDoc tool searches directories in the source path for the files to process.
For each namespace that you want to exclude, add a new
For example, the Flex mx/core package contains several include files that are not stand-alone classes, but files included by other classes. The following example specifies only the mx.controls.Button class as input:asdoc -source-path C:\flex\frameworks\projects\framework\src -doc-classes mx.controls.Button -output framework-asdoc The output of the build includes the mx.controls.Button class, plus any class referenced by the You can specify an absolute or relative path. his comment is here The following example uses the lenient option:asdoc -doc-sources C:\flex\frameworks\projects\framework\src\mx\controls\Button.as -lenient -output framework-asdoc With the lenient option, you see the same error message, and the ASDoc tool writes the same information to
But, the tool generates the output, as the following message shows:[Fatal Error] :10:5: The element type "code" must be terminated by the matching end-tag "". Specify multiple paths separated by spaces, as the following example shows:asdoc -doc-sources C:\a\flex\flex\sdk\frameworks\projects\framework\src\mx\core -exclude-sources C:\a\flex\flex\sdk\frameworks\projects\framework\src\mx\core\Version.as Excluding a namespaceTo exclude an entire namespace from ASDoc, edit the ASDoc_Config_Base.xml file in the asdoc\templates You must specify the package name of the files to omit, such as mx.controls.Button, separated by spaces.
Therefore, to build ASDoc for the SWC file, you specify both as input. The asdoc command also recognizes the following options from the compc component compiler: -source-path -library-path -namespace -load-config -actionscript-file-encoding -help -advanced -benchmark -strict -warnings For more information, see Using mxmlc, the application Compiling dependent filesWhen performing a build, the ASDoc tool compiles the input files and also attempts to compile any dependent files referenced by the input files. The classes must be in the source path.
Notice that this option uses the += syntax to add configFileName.xml to the list of configuration files so that the tool still includes the flex\frameworks\flex-config.xml configuration file. The default value is 210 pixels. -lenient Ignore XHTML errors (such as a missingtag) and produce the ASDoc output. The examples must be located under this directory in subdirectories that correspond to the package name of the class. http://wiicentre.com/asdoc-error/asdoc-error-framework.html For example, you specify class A as an input by using the doc-classes option.
This option specifies the root directory. The ASDoc tool writes any compilation, such as syntax errors, errors to the console window. Home / Using Flex / Developer tools / ASDoc By default, classes that do not define constructors, or contain methods that do not define return values cause compiler failures.
You can specify more than one package option.