I think the problem is that you have to list all the classes you want to
exclude. In other words, you want to exclude packages, as you said, but
there's no option to exclude a package, you have to list all the classes.
If that's the case, a possible solution -other than doing it manually- is
using some script to generate a list of these classes given a path, then
copy + paste that after the -exclude-classes option.
Listing files is not that hard in batch and since you're on windows, you
have that option available already:
DIR /S /B *.as > fileList.txt
The problem is you have now a list of full paths. Converting a path to a
class name is not rocket science in any decent scripting language, but batch
hasn't earn the crappy reputation it has for being... easy to work with.
This should be easy to accomplish in php, python, etc, if any of these
is available in your computer. Or, maybe, you can try to write a JSFL script
to do the job, though you'll have to run it from flash. Or maybe an air app
if you're so inclined (perhaps overkill, but you already know actionscript,
so maybe it's the fastest option)
Anyway, I think if you manage to automate the generation of the exclude
list, you will be able to run the asdoc task without much manual work.
Just a few ideas, hope it helps.
Cheers
Juan Pablo Califano
2010/4/13 Merrill, Jason <jason.merr...@bankofamerica.com>
> >> 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
>
> On Thu, Apr 8, 2010 at 10:30 AM, Merrill, Jason <
> jason.merr...@bankofamerica.com> wrote:
>
> > Those of you who use ASDoc I'm sure have come across this before.
> > If you
> > use FlashDevelop and ASDoc - then even better as that is my setup.
> >
> > 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?
> >
> > 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)
> >
> >
> >
> >
> >
> >
> > _______________________________________________
> > Flashcoders mailing list
> > Flashcoders@chattyfig.figleaf.com
> > http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
> >
> _______________________________________________
> Flashcoders mailing list
> Flashcoders@chattyfig.figleaf.com
> http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
>
> Karl DeSaulniers
> Design Drumm
> http://designdrumm.com
>
> _______________________________________________
> Flashcoders mailing list
> Flashcoders@chattyfig.figleaf.com
> http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
> _______________________________________________
> Flashcoders mailing list
> Flashcoders@chattyfig.figleaf.com
> http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
>
> Karl DeSaulniers
> Design Drumm
> http://designdrumm.com
>
> _______________________________________________
> Flashcoders mailing list
> Flashcoders@chattyfig.figleaf.com
> http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
> _______________________________________________
> Flashcoders mailing list
> Flashcoders@chattyfig.figleaf.com
> http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
>
> Karl DeSaulniers
> Design Drumm
> http://designdrumm.com
>
> _______________________________________________
> Flashcoders mailing list
> Flashcoders@chattyfig.figleaf.com
> http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
> _______________________________________________
> Flashcoders mailing list
> Flashcoders@chattyfig.figleaf.com
> http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
>
> Karl DeSaulniers
> Design Drumm
> http://designdrumm.com
>
> _______________________________________________
> Flashcoders mailing list
> Flashcoders@chattyfig.figleaf.com
> http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
>
> Karl DeSaulniers
> Design Drumm
> http://designdrumm.com
>
> _______________________________________________
> Flashcoders mailing list
> Flashcoders@chattyfig.figleaf.com
> http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
> _______________________________________________
> Flashcoders mailing list
> Flashcoders@chattyfig.figleaf.com
> http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
>
_______________________________________________
Flashcoders mailing list
Flashcoders@chattyfig.figleaf.com
http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
