Archive for the 'ASDoc' Category
ASDoc Bug
I’ve known about this bug for a while, just forgot to say something. It’s a very miniscule bug, but can be confusing to someone reading documentation generated by asdoc.
Take a look at this method definition:
public function flipProp(prop:String,value1:*,value2:*,...objs:Array):void
Now take a look at the method documentation here.
Notice a difference in the method definitions?
The answer: asdoc documents the method as if it were declared like this:
public function flipProp(prop:String,...value1,value2:*,objs:*):void
Notice that asdoc reverses the order of the (…) rest style parameter, with the objects that are defined as *. The only time it happens is if there are three or more parameters involved in the method. And it only happens when you use rest (…), immediately preceded by a *.
No my docs aren’t wrong. It’s asdoc!
No comments