Comments on: The joys of ASDoc (sort of) http://www.flexstuff.co.uk/2008/11/26/the-joys-of-asdoc%e2%80%a6/ Stuff about Flex. And Air. Oh and Flash. And probably about other stuff as well. Who knows? Wed, 25 Jan 2012 18:56:19 +0000 hourly 1 http://wordpress.org/?v=3.3.1 By: gillesguillemin http://www.flexstuff.co.uk/2008/11/26/the-joys-of-asdoc%e2%80%a6/comment-page-1/#comment-372 gillesguillemin Thu, 18 Feb 2010 10:32:39 +0000 http://www.bvproject.com/flexstuff/?p=19#comment-372 Hehe, I must say I ended up doing that the other day for the exact same reason. Better, now VisDoc is open source! Hehe, I must say I ended up doing that the other day for the exact same reason. Better, now VisDoc is open source!

]]> By: Severin Klaus http://www.flexstuff.co.uk/2008/11/26/the-joys-of-asdoc%e2%80%a6/comment-page-1/#comment-371 Severin Klaus Thu, 18 Feb 2010 10:29:10 +0000 http://www.bvproject.com/flexstuff/?p=19#comment-371 You saved my day!! No, not with ASDoc, but with VisDoc – that's how easy ASDoc should be. I really tried, also downloaded the great ASDocr from Grant, but with anything but bloody simple stuff there was no way. My projects usually rely on other libraries, and those libraries usually are kept up to date using svn, having them in external directories (not in src), and having them as source code (not as swc). ASDoc just has no way of dealing with anything like that. In my opinion the only way around this is a decent integration into Flash Builder (as they've done with compc). Anything else is a pain in the ass, and Adobe, I don't want you to be that ;-) Again, Gilles, thanks for pointing me to VisDoc! (How could I not know about that!) You saved my day!! No, not with ASDoc, but with VisDoc – that’s how easy ASDoc should be.

I really tried, also downloaded the great ASDocr from Grant, but with anything but bloody simple stuff there was no way. My projects usually rely on other libraries, and those libraries usually are kept up to date using svn, having them in external directories (not in src), and having them as source code (not as swc). ASDoc just has no way of dealing with anything like that.

In my opinion the only way around this is a decent integration into Flash Builder (as they’ve done with compc). Anything else is a pain in the ass, and Adobe, I don’t want you to be that ;-)

Again, Gilles, thanks for pointing me to VisDoc! (How could I not know about that!)

]]> By: gillesguillemin http://www.flexstuff.co.uk/2008/11/26/the-joys-of-asdoc%e2%80%a6/comment-page-1/#comment-359 gillesguillemin Wed, 20 Jan 2010 18:16:05 +0000 http://www.bvproject.com/flexstuff/?p=19#comment-359 Actually, Grant Skinner might have saved your day guys: check his new AIR2 application, <a href="http://www.gskinner.com/blog/archives/2010/01/asdocr_simple_a.html" rel="nofollow">ASDocr</a> Actually, Grant Skinner might have saved your day guys: check his new AIR2 application, ASDocr

]]> By: gillesguillemin http://www.flexstuff.co.uk/2008/11/26/the-joys-of-asdoc%e2%80%a6/comment-page-1/#comment-357 gillesguillemin Mon, 11 Jan 2010 09:24:39 +0000 http://www.bvproject.com/flexstuff/?p=19#comment-357 Well, I wish I could help but like I said already a year ago when I initially wrote this post, ASDoc is a bag of hurt and the solution I offered is, well, one year old now. Gumbo has turned into Flex 4, Flex Builder has become Flash Builder, so what was true by then is very likely not being true anymore... Maybe you should have a look at Jesse's and Adam's solutions as well. Well, I wish I could help but like I said already a year ago when I initially wrote this post, ASDoc is a bag of hurt and the solution I offered is, well, one year old now. Gumbo has turned into Flex 4, Flex Builder has become Flash Builder, so what was true by then is very likely not being true anymore… Maybe you should have a look at Jesse’s and Adam’s solutions as well.

]]> By: Eugene Se http://www.flexstuff.co.uk/2008/11/26/the-joys-of-asdoc%e2%80%a6/comment-page-1/#comment-356 Eugene Se Sun, 10 Jan 2010 20:58:05 +0000 http://www.bvproject.com/flexstuff/?p=19#comment-356 Hi, Thanks for your info. I'm actually in the same situation: need ASDoc to generate documentation for mxml classes, but the team is still working with sdk 3.x. Could you explain how I can use the Gumbo ASDoc version with sdk 3.x? If I follow your example (and have the frameworks/lib point at the Gumbo sdk), I get a lot of errors because it is trying to complie my 3.x project with an 4.x sdk. At least, I think that that's happening. I tried to copy some file from Gumbo to the 3.x sdk (bin/asdoc and asdoc/) but that wasn't very succesful. Could you please shine a light on this issue? Thanks! Eugene Hi,
Thanks for your info.

I’m actually in the same situation: need ASDoc to generate documentation for mxml classes, but the team is still working with sdk 3.x. Could you explain how I can use the Gumbo ASDoc version with sdk 3.x? If I follow your example (and have the frameworks/lib point at the Gumbo sdk), I get a lot of errors because it is trying to complie my 3.x project with an 4.x sdk. At least, I think that that’s happening.

I tried to copy some file from Gumbo to the 3.x sdk (bin/asdoc and asdoc/) but that wasn’t very succesful.

Could you please shine a light on this issue?

Thanks!
Eugene

]]> By: Jesse Freeman http://www.flexstuff.co.uk/2008/11/26/the-joys-of-asdoc%e2%80%a6/comment-page-1/#comment-48 Jesse Freeman Wed, 24 Jun 2009 14:21:13 +0000 http://www.bvproject.com/flexstuff/?p=19#comment-48 I agree with Adam, ANT is really the way to go with ASDoc. I still can't believe that Adobe hasn't built this into Flash Builder yet, I mean come on we now have support for unit testing. I guess code documenting is not high on people's list. For the most part, I haven't had to many issues with ASDoc. You really have to use ANT and having multiple external libraries/swcs can be a real pain to deal with in the command line part of the external tools area in Eclipse. Make sure you keep your commenting clean and you should be fine. I noticed right away that ASDoc really freaks out when you have broken/missing HTML tags in your comments. The most important reason to run ASDoc though ANT is that if you can get your ActionScript/Flex project to compile with ANT you simply copy over that target and point it to ASDoc. This way you do all the leg work ahead of time. I agree with Adam, ANT is really the way to go with ASDoc. I still can’t believe that Adobe hasn’t built this into Flash Builder yet, I mean come on we now have support for unit testing. I guess code documenting is not high on people’s list.

For the most part, I haven’t had to many issues with ASDoc. You really have to use ANT and having multiple external libraries/swcs can be a real pain to deal with in the command line part of the external tools area in Eclipse. Make sure you keep your commenting clean and you should be fine. I noticed right away that ASDoc really freaks out when you have broken/missing HTML tags in your comments.

The most important reason to run ASDoc though ANT is that if you can get your ActionScript/Flex project to compile with ANT you simply copy over that target and point it to ASDoc. This way you do all the leg work ahead of time.

]]> By: Adam Chappell http://www.flexstuff.co.uk/2008/11/26/the-joys-of-asdoc%e2%80%a6/comment-page-1/#comment-6 Adam Chappell Thu, 30 Apr 2009 13:55:40 +0000 http://www.bvproject.com/flexstuff/?p=19#comment-6 If you're running Flex Builder 3 you could try the ANT task as mentioned in Eric Feminella's blog. I found I got it working fairly quickly. http://www.ericfeminella.com/blog/2007/12/28/running-asdoc-against-air-projects/ If you’re running Flex Builder 3 you could try the ANT task as mentioned in Eric Feminella’s blog.

I found I got it working fairly quickly.

http://www.ericfeminella.com/blog/2007/12/28/running-asdoc-against-air-projects/

]]> By: Gilles Guillemin http://www.flexstuff.co.uk/2008/11/26/the-joys-of-asdoc%e2%80%a6/comment-page-1/#comment-435 Gilles Guillemin Thu, 16 Apr 2009 05:41:49 +0000 http://www.bvproject.com/flexstuff/?p=19#comment-435 <span class="topsy_trackback_comment"><span class="topsy_twitter_username"><span class="topsy_trackback_content">New post on #FlexStuff: The joys of ASDoc (sort of) http://tr.im/iW9B</span></span> New post on #FlexStuff: The joys of ASDoc (sort of) http://tr.im/iW9B

]]>