[flexcoders] ASDoc and third party libraries

2010-04-08 Thread Merrill, Jason
Those of you who use ASDoc from the Flex 3 SDK I'm sure have come across
this before. If you use FlashDevelop and ASDoc - then even better as
that is my setup (this is actually for a Flash CS3 project, but no
matter).

How do you handle running ASDoc on a Flash or Flex project where you are
also using other third party libraries?  If you run ASDoc on a project
that uses a third party library like Greensock's TweenLite or
Papervision3D, as I am, you can get all kinds of compiler errors because
it tries to include those in the documentation as well (since they are
imported into your classes), and those are not necessarily set up for
ASDoc.  I know in FlashDevelop, the Actionscript Documentation Generator
has a field for classes to exclude - but it would be impossible to list
out all those third party classes - is there a way to exclude an entire
package?

I have tried various forms of adding -exclude-dependencies but keep
getting this error:

Error: exclude-dependencies can not be used with doc-sources.

And honestly, I'm not even sure how to use that flag correctly (if
that's even the right flag at all).  I tried adding a class name right
after it but it couldn't find the class.  Searching online for an hour
has done no good.  The documentation really stinks for ASDoc and so does
the help system you can call with a -help flag.  

Any ideas?  Thanks.


Jason Merrill 

Bank of  America  Global Learning 
Learning  Performance Solutions

Join the Bank of America Flash Platform Community
http://sharepoint.bankofamerica.com/sites/tlc/flash/default.aspx   and
visit our Instructional Technology Design Blog
http://sharepoint.bankofamerica.com/sites/SDTeam/itdblog/default.aspx 
(note: these are for Bank of America employees only)








Re: [flexcoders] ASDoc and third party libraries

2010-04-08 Thread Oleg Sivokon
Hi.

http://www.flashdevelop.org/community/viewtopic.php?f=13t=4555p=21134hilit=asdocs#p21134

This may be of some help, but, maybe also not enough info... Besides, I'd
try looking at this plugin:
http://www.flashdevelop.org/community/viewtopic.php?f=4t=4641 AFAIK elyon
has made some include / exclude automation.
Besides, I think you should be OK if you update only the ASDocs utility
(while still compile with the older SDK). It actually got better in the last
versions.
Another idea - maybe look at NaturalDocs / ZenDocs. I think I saw someone
made AS3 adapter for ZenDocs and NaturalDocs are quite generic to handle
lots of languages and different documentation styles, besides, they generate
valid HTML and, to my taste, just looks better.

Best.

Oleg