Questions tagged [asdoc]

ASDoc is a command-line tool used to create API language reference documentation as HTML pages from ActionScript 3 and MXML classes.

The ASDoc tool parses one or more class definitions and files, and generates API language reference documentation for all public and protected methods and properties, and for all [Bindable], [DefaultProperty], [Event], [Style], and [Effect] metadata tags.

You can specify a single class, multiple classes, an entire namespace, or a combination of these inputs as inputs to the ASDoc tool.

ASDoc generates its output as a directory structure of HTML files that matches the package structure of the input class files. Also, ASDoc generates an index of all public and protected methods and properties. To view the ASDoc output, you open the index.html file in the top-level directory of the output.

53 questions
1
vote
2 answers

Generating Warnings for Undocumented AS3 Members? (ASDoc)

I have a Flash (AS3) component library that I'm distributing, and I want to make sure that it's fully documented for each release. One of the things I really liked about Microsoft's automatic doc generation for C# was that I could have my compiler…
HanClinto
  • 9,423
  • 3
  • 30
  • 31
1
vote
1 answer

How to get value labels as table title using asdoc command in stata?

I have a dataset that has a categorical variable(eg: crops) and continuous variables (e.g: yield, price,input costs). I want to summarize the continuous by each category of crop. I currently use the below command label define crops 1"Paddy" 2"Wheat"…
1
vote
1 answer

asdoc "access of undefined property JSON"

I've been doing pages and pages of research and have tried a number of options and now I'm posting to sof in hopes that someone with prior asdoc experience will know how to remedy this: script: /asdoc \ -source-path ./flash/…
Jacksonkr
  • 31,583
  • 39
  • 180
  • 284
1
vote
1 answer

ASDoc Generation through Ant

I have an ant script to compile and generate an AIR file, and it runs well. Now, I am trying asDocs also into the ant script in order to auto generate documentation whenever I am generating a new AIR file. Though the mxmlc task which is creating my…
Neo
  • 1,554
  • 2
  • 15
  • 28
1
vote
1 answer

Adding XML to asdoc function comments in flex?

How do you add sample xml to asdoc function/class comments in Flex? They can obviously be added, but they wont show in the hover asdoc comments in Flash Builder 4. /** * Generates a ChangeAccount in xml format when they are being saved * *…
Drenai
  • 11,315
  • 9
  • 48
  • 82
1
vote
1 answer

ASDocs Omitting Private Members

Hail Stack!! I'm developing a framework for my coworkers and I'm having trouble documenting it. ASDocs as omitting the private members (even without @private directive). Is there any way to force it to document it??
NemoStein
  • 2,088
  • 2
  • 22
  • 36
1
vote
1 answer

Add ASDoc documentation to Flex Builder help

Is there any way to add my project documentation, generated with ASDoc, to the Flex Builder dynamic help? Or not necessarily to the dynamic help, but somewhere so that Flex Builder searches it when I press F1. I'm using Flex Builder 3 with SDK…
Corneliu Dascălu
  • 3,900
  • 1
  • 28
  • 38
1
vote
1 answer

How to force asdoc run in English

My operation system is Window XP in Chinese. I'm running flex sdk > asdoc in command line. Asdoc picks up the system default language. How can I force it to be run in English language environment?
teleme.io
  • 815
  • 3
  • 10
  • 21
1
vote
1 answer

Using "protected" instead "private" - Action Script 3

I'm using ASDocs to make something like a "help" for my code and the problem is PRIVATE methods are omitted on ASDocs. The thing is, on my project, I don't see any problems in change what is PRIVATE to PROTECTED. If I do that, the docummentation…
1
vote
1 answer

How do I troubleshoot an "Error #1090" trying to generate ASDoc?

I've got a reasonably large Flex project and I'm trying to generate ASDoc documentation for it. When I run asdoc, it gives me this error: An unexpected error occurred. Error #1090: XML parser failure: element is malformed. (Location of error…
Andrew Aylett
  • 39,182
  • 5
  • 68
  • 95
1
vote
1 answer

Include @ in ASDoc comments without any errors?

If you have the @ symbol in your ASDoc, the code will compile, but the generator for the ASDoc will yell out an unintelligible error message. /** * Removes the following characters which are forbidden: * @/\"#$%&'()*:;<=>!? */ public function…
IQAndreas
  • 8,060
  • 8
  • 39
  • 74
1
vote
2 answers

Why won't asdoc generate?

I'm trying to generate an asdoc right now. The project is two classes. One class extends View and another is a custom Event class. Really, really simple. I cannot, for the life of me, get the asdoc to properly generate. I've tried so many different…
Josh
  • 8,079
  • 3
  • 24
  • 49
1
vote
2 answers

How can ASDoc Ant Task work without -source-path option?

I am tring to get the ASDoc Ant task to work: When…
MidnightGun
  • 1,006
  • 1
  • 19
  • 39
1
vote
2 answers

Creating AsDoc I keep getting "Error: Type was not found or was not a compile-time constant: "

I'm trying to create AsDoc with Flash Develop tool :/. It keeps giving me this error. col: 41 Error: Type was not found or was not a compile-time constant: antenaCoupler. public function AntennaKeyPad(v:antenaCoupler, m:AntennaCouplerModel,…
Tim Lieberman
  • 571
  • 2
  • 5
  • 23
1
vote
1 answer

Adobe ASC 2.0 and ASDoc

After upgrading to the AIR 3.6 SDK which uses the new ASC 2.0 compiler all the ASDoc tasks in my Ant build files fail. I'm getting the error: BUILD FAILED E:\Projects\Eclipse\project\build\build_swc.xml:51: The following error occurred while…
BadmintonCat
  • 9,416
  • 14
  • 78
  • 129