Using ASDoc with Bindable metatag and mxml
I am creating documentation for my flex project using ASDoc and have some problems with the bindable meta tag.
- ASDoc does not document values
public Bindable
unless the Bindable tag is associated with it with an event name.
For example:
//This is documented correctly
[Bindable("someEvent")]
/*
* public bindable with event name
* */
public var test1:String;
//This is not documented at all
[Bindable]
/*
* public bindable without event name
* */
public var test2:String;
- ASDoc adds random strings to value names
protected Bindable
if the bindable tag does not have an event name associated with it.
For example:
//This is documented correctly as test3
[Bindable("someEvent")]
/*
* protected bindable with event name
* */
protected var test3:String;
//But this is documented as _110251490test4
[Bindable]
/*
* protected bindable without event name
* */
protected var test4:String;
To summarize, ASDoc is not satisfied with tags Bindable
without an event name. A simple solution seems to be giving the event name when you declare something as Bindable. But the flex docs say that if u specifies an event name with a Bindable tag, then "you are responsible for firing and dispatching the event." My project is almost complete and I relied on anchor (no event names) in many places, making it impossible to go back and change everything - it will take a lot of effort; plus the idea of messing up working code to generate documentation sounds scary to me.
Replacing all the instances [Bindable]
with [Bindable("blah")]
before generating the asdoc and then replacing them is the only workaround I can think of. But I believe there must be a better way.
Adobe Bug Tracking claims that the public variables issue was fixed in the last build, so I downloaded the latest flex sdk (3.4) and tried with the ASDoc that came with it, but it gave me the same result.
Can anyone shed some light on this issue?
Also, the Adobe blog says ASDoc now supports mxml too, but when I tried with the latest (Flex 3.4) ASDoc my mxml asdoc comments (inline) do not appear on the html page that was generated. does anyone know if it is possible to download the latest asdoc separately?
source to share