You might want to check out SourceMate for Flash Builder 4 - it has an ASDoc tool that makes it relatively simple to include/exclude classes (one click can exclude a whole package). http://www.elementriver.com/sourcemate/
Although it sounds like you're not a Flash Builder 4 guy, so that may not help much. Also, for the record, the GreenSock downloads have included a .swc file for a while. Not that it solves your problem, but I noticed it mentioned earlier in the thread so I figured I'd clarify. Jack -----Original Message----- From: Merrill, Jason [mailto:jason.merr...@bankofamerica.com] Sent: Tuesday, April 13, 2010 5:13 PM To: Flash Coders List Subject: RE: [Flashcoders] ASDoc & third party libraries >> asdoc -source-path . -doc-sources . -exclude-classes comps.PageWidget >>comps.ScreenWidget Thanks, I've tried that all different ways substituting in com.greensock.TweenLite - no luck. Here is a sample class that imports Greensock's TweenLite class which in tests I cannot get ASDoc to exclude TweenLite. If anyone knows how to get this class documented in ASDoc without compiler errors, I'm all ears. package { import flash.display.Sprite; import com.greensock.TweenLite /** * ... * @author Jason Merrill */ public class Main extends Sprite { private var _mySprite:Sprite; /** * Constructor * @param duration the duration of the animation */ public function Main(duration:Number) { TweenLite.to(_mySprite, duration, {x:10, y:10 } ); } } } Jason Merrill Bank of America Global Learning Learning & Performance Solutions Join the Bank of America Flash Platform Community and visit our Instructional Technology Design Blog (note: these are for Bank of America employees only) -----Original Message----- From: flashcoders-boun...@chattyfig.figleaf.com [mailto:flashcoders-boun...@chattyfig.figleaf.com] On Behalf Of Karl DeSaulniers Sent: Tuesday, April 13, 2010 5:48 PM To: Flash Coders List Subject: Re: [Flashcoders] ASDoc & third party libraries One last one, maybe to redeem myself, lol :) ///////////////////////////////////////////////// Excluding classes All of the classes specified by the doc-classes, doc-sources, and doc- namespaces options are documented, with the following exceptions: If you specified the class by using the exclude-classes option, the class is not documented. If the ASDoc comment for the class contains the @private tag, the class is not documented. If the class is found in a SWC, the class is not documented. In the following example, you generate output for all classes in the current directory and its subdirectories, except for the two classes comps\PageWidget and comps\ScreenWidget.as: asdoc -source-path . -doc-sources . -exclude-classes comps.PageWidget comps.ScreenWidget Note that the excluded classes are still compiled along with all of the other input classes; only their content in the output is suppressed. If you set the exclude-dependencies option to true, dependent classes found when compiling classes are not documented. The default value is false, which means any classes that would normally be compiled along with the specified classes are documented. For example, you specify class A by using the doc-classes option. If class A imports class B, both class A and class B are documented. ///////////////////////////////////////////////// From: http://livedocs.adobe.com/flex/3/html/help.html? content=asdoc_3.html GL, Karl A man who says he just doesn't know will never know, but a man who says he thinks he can know, eventually will. On Apr 13, 2010, at 4:39 PM, Karl DeSaulniers wrote: None taken. Karl On Apr 13, 2010, at 4:23 PM, Merrill, Jason wrote: My file that calls ASDoc class?? Can you explain? ASDoc is a documentation compiler that comes with the Flex SDK. Not a "class". Again, have you used ASDoc or are you just guessing? I DO appreciate the help, but I am thinking you know less about ASDoc than I do - no offense. :) Jason Merrill Bank of America Global Learning Learning & Performance Solutions Join the Bank of America Flash Platform Community and visit our Instructional Technology Design Blog (note: these are for Bank of America employees only) -----Original Message----- From: flashcoders-boun...@chattyfig.figleaf.com [mailto:flashcoders-boun...@chattyfig.figleaf.com] On Behalf Of Karl DeSaulniers Sent: Tuesday, April 13, 2010 5:05 PM To: Flash Coders List Subject: Re: [Flashcoders] ASDoc & third party libraries Well, I must admit it is a theory more so. Probably a better solution than that. Is it possible that in your file that calls ASDoc, where it goes to actually call the ASDoc class, having conditional statements add the includes to the other classes only if the ASDoc is finished loading? Sort of putting the ASDoc in a pseudo cue? That aside, I found this information on Excluding in ASDoc. //////////////////////////////////////////// Excluding an inherited element By default, the ASDoc tool copies information and a link for all ActionScript elements inherited by a subclass from a superclass. In some cases, a subclass may not support an inherited element. You can use the [Exclude] metadata tag to cause ASDoc to omit the inherited element from the list of inherited elements. The [Exclude] metadata tag has the following syntax: [Exclude(name="elementName", kind="property|method|event|style|effect")] For example, to exclude documentation on the click event in the MyButton subclass of the Button class, insert the following [Exclude] metadata tag in the MyButton.as file: [Exclude(name="click", kind="event")] //////////////////////////////////////////// I found this at http://livedocs.adobe.com/flex/3/html/help.html? content=asdoc_3.html HTH, Karl On Apr 13, 2010, at 3:45 PM, Merrill, Jason wrote: >> If the var is not present, exclude the class. How is that done with ASDoc? I don't follow. Have you used ASDoc? I believe it looks at your import statements - or at minimum, your typecasting - you can't control what it looks for via Actionscript logic. Is that what you're suggesting? Or are you talking about some ASDoc compiler directives? Jason Merrill Bank of America Global Learning Learning & Performance Solutions Join the Bank of America Flash Platform Community and visit our Instructional Technology Design Blog (note: these are for Bank of America employees only) -----Original Message----- From: flashcoders-boun...@chattyfig.figleaf.com [mailto:flashcoders-boun...@chattyfig.figleaf.com] On Behalf Of Karl DeSaulniers Sent: Tuesday, April 13, 2010 4:42 PM To: Flash Coders List Subject: Re: [Flashcoders] ASDoc & third party libraries Sorry, after I read my post I didn't follow it either. :P Basically, I was thinking you could put a private function in your classes that tells if it is being included. Within that function it checks the calling class to see if a private var is present (IE: the classes you control WILL have this var because you put it there.) If the var is not present, exclude the class. Probably not what you need at this point after reading your further posts, but wanted to explain myself. Karl On Apr 13, 2010, at 10:21 AM, Merrill, Jason wrote: Sorry, I didn't follow that at all. AFAIK, ASDoc looks for any imports in your classes and tries to compile those imported classes as well. Jason Merrill Bank of America Global Learning Learning & Performance Solutions Join the Bank of America Flash Platform Community and visit our Instructional Technology Design Blog (note: these are for Bank of America employees only) -----Original Message----- From: flashcoders-boun...@chattyfig.figleaf.com [mailto:flashcoders-boun...@chattyfig.figleaf.com] On Behalf Of Karl DeSaulniers Sent: Monday, April 12, 2010 11:24 PM To: Flash Coders List Subject: Re: [Flashcoders] ASDoc & third party libraries Maybe build a function that controls the class hierarchy and in the classes you control, set a specific variable that gets read with this function and makes sure that if the variable is not present, to exclude that classes information in any calls from third party classes that don't have that variable in it. Karl On Apr 12, 2010, at 10:14 PM, Ktu wrote: I'm assuming you've already googled it, and that your google foo is strong because I did not search. If there doesn't seem to be a way to do it there is the annoying way: copy just the files you want ASDoc'ed into a different directory... I've done it before for its simplicity, but not a great long term solution Ktu _______________________________________________ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
