Flex Help document (HTML format) production and Asdoc use _flex

Recent work on the need for these months to develop the Flex Realspace products in the SP3 when the online, urgent need to make help documents, before the development of the annotations are according to the habitual uninstall code inside, also did not consider the later help documents, these days worry Ah, Company's other flex products are written with their own bag tools, I do not have so much time, looked at a lot of information, hoping to achieve through the Asdoc wish.

Asdoc is the Adobe official ActionScript API documentation generation tool, already integrated in Flex Builder, I use Flex Builder4.6, using the following method;

1. Configure an environment to generate documentation first, follow these steps

Run-> External Tools-> External tool configuration

Click "New boot Configuration" to create the following interface, fill in the following information:

Name: Random, here I take the asdoc.
Location: Select your installation directory under the AsDoc.exe location of the path, my is D:\Adobe flash Builder 4.6\adobe Flash Builder 4.6\sdks\4.6.0\bin\asdoc.exe
Working directory: Direct defaults to ${project_loc} so the system will be the default output item from the project where you currently open the as class or Mxml file
Independent variables: This parameter on the Internet a lot of information, I do not specify here
-source-path: The directory where the code resides (not in the Chinese directory)
-doc-sources: The directory where the files are located (not in the Chinese directory)
-output: The directory of the output document (not in Chinese directory)
-external-library-path: Extended lib Path (path to external SWC) (cannot be in Chinese directory)
-main-title the title displayed on the first page of the document, here I add "Supermap iclient 6R for Flex realspace Help Document"
Here I wrote the following three, the first two must be written.
-source-path SRC
-doc-sources SRC
-main-title "Supermap iclient 6R for Flex realspace Help Document"

2. Document Support Chinese annotation

In order for the generated document to support Chinese annotations, we need to switch to "public", encode-> other-> select UTF-8. As follows:

3, Operation

Click "Apply" to save, we can directly click on the operation below, at the same time, click on the application will be in the external tool inside can generate a shortcut key, later it is very convenient, and can be modified again.

The final console appears as if the build was successful, if the red font appears, there are errors, the most common error

[Fatal Error] toplevel.xml:25186:244:the value of "DefaultValue" must not contain the ' < ' character.

Error:could not create toplevel.xml:The value of attribute "DefaultValue" must not contain the ' < ' character.

It's because there are some problems with your notes, such as whether the tags are closed or not, some special characters are used, such as ><@, <b>, etc. Sdk4.x itself is not wrong, but fault tolerance is poor, error hint is bad, but as long as the rules to write, you can pass.

After the successful file the following red circle file interior:

Click the index.html in this file to view the resulting interface as follows:

Attentive readers may find themselves generated in English, while mine is Chinese version, and some icons have been changed, find your own flash Builder installation directory, in D:\Adobe flash Builder 4.6\adobe Flash Builder 4.6\ Sdks\4.6.0\asdoc there is a folder called templates, in fact, we pack is relying on the contents of this folder, our company made some changes, and then replace the file, it can be Chinese, and support their own company's icon, there is want to leave a message, Write your own mailbox.