Stack Overflow
Stack Overflow

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
6
votes
3 answers

Fixing broken paths in ASDoc?

This question concerns using ASDoc to create documentation from AS3. I'm not doing this from Flex or anything, just using the command line, and though everything works fine and ASDoc doesn't return any errors, some of the links in the resulting…
fenomas
  • 11,131
  • 2
  • 33
  • 57
4
votes
5 answers

ASDoc through the Flex Builder UI?

Is there any way to run ASDoc on your project via the Flex Builder UI? Or, is there a good (preferably free) plugin that will do so? If there is no UI for it, does someone have a link to a tutorial on how to set it up to be automatic when I build…
RickDT
  • 2,104
  • 1
  • 23
  • 25
3
votes
3 answers

ASDoc compiling error in Flash Builder 4

I can't seem to figure out why i continue getting this error every-time I try to compile ASDoc in Flash Builder 4. I did succeed in ASDoc creating a asdoc-output folder but it is incomplete. There is only toplevel.xml and a tempdita folder that show…
abritez
  • 2,616
  • 3
  • 29
  • 36
3
votes
1 answer

Asdoc throwing errors for MXML component that includes a separate .as file

I have an MXML component that includes a .as file with Running asdoc throws a whole bunch of errors like "Error: The private attribute may be used only on class property definitions." "Error: The public attribute…
Atorian
  • 777
  • 10
  • 26
3
votes
1 answer

problems generating ASDoc

I am using ASDocr, which is an Adobe AIR application GUI interface for the command-line Flex asdoc documentation generator. My class uses several external libraries and it is generating a 1046 error when creating the…
mga
  • 1,960
  • 1
  • 23
  • 31
2
votes
1 answer

How do I get the asdoc output table to show both the variable labels and value labels in Stata?

I'm trying to make a table using asdoc that will include both the value labels and the variable labels in the output. When I run the following line of code in Stata asdoc list progname progtype progterm publicprivate cohortsize grereq, label I get…
C.K.
  • 75
  • 2
  • 8
2
votes
1 answer

Where does ASDoc get its intrinsic class definitions from?

I mean that of the built-in ECMA objects: String, Number, Object, Function, RegExp, Error, Boolean, etc..
Tim Whitlock
  • 1,111
  • 9
  • 17
2
votes
2 answers

Is it possible to include example mxml in your ASDoc?

Is it possible with ASDoc to include example MXML code in your comment? /** * @example This should be example code * * * */ This produces an empty…
trashcanman
  • 48
  • 3
2
votes
1 answer

Documenting private members with ASDoc

Can ASDoc be set to document private members ala JavaDoc?
BefittingTheorem
  • 10,459
  • 15
  • 69
  • 96
2
votes
1 answer

Generating ASDoc for a Project that uses SWCs

I'm using FlashDevelop and it's ActionScript Documentation Generator. I have a project that uses several SWC files that are added to the .as3proj library. Some of the classes in my project extend classes that are in the SWC files. Which causes…
jshbrntt
  • 5,134
  • 6
  • 31
  • 60
2
votes
2 answers

custom pages using asdoc

Does anyone know if you can write your own pages that asdoc will recognize and use? For instance, I'd like to write some "Getting Started","Support" and "FAQ" kind of pages that will help understanding what my actionscript classes are about.
cmroanirgo
  • 7,297
  • 4
  • 32
  • 38
2
votes
2 answers

Using ASDoc with Bindable metatag and mxml

I am creating the documentation of my flex project using ASDoc and having some issues with the bindable metatag. ASDoc doesn't document public Bindable values unless the Bindable tag has an event name associated with it. For example: //This is…
Amarghosh
  • 58,710
  • 11
  • 92
  • 121
1
vote
1 answer

How to properly exclude dependencies from ASDoc?

I have read some questions on StackOverflow on how to exclude the dependencies when creating the asdoc from Ant, but it seems I may not get it right. Here (http://livedocs.adobe.com/flex/3/html/help.html?content=asdoc_9.html) it says to simply set…
jansensan
  • 633
  • 1
  • 8
  • 23
1
vote
3 answers

Flex 3 ASDocs Library Issue

We've been attempting to compile ASDocs against a Flex 3 Library Project. Our problem is that ASDocs refuses to recognize any custom mxml component that is both created and used within the library. For example, if we have a custom mxml…
Yarin Kessler
1
vote
1 answer

ANT script : how to exclude several files with ASDOC engine

I want to exclude several files (*_include.as) in my source project, to generate ASDOC :
Anthony
  • 325
  • 2
  • 5
  • 15
1
2 3 4