RE: [Flashcoders] ASDoc third party libraries
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
Re: [Flashcoders] ASDoc third party libraries: TEST
Hi Jason,
been experimenting.
as long you don't have typed TweenLite vars that point to a Tweenlight
class and if you copy over the com.greenscok package to a seperate LIB
folder (that you can include in your project as a second base classpath
node)
the SRC folder will compile fine this way:
I used this structure to test:
+---src
| | Main.as
| |
| \---sub
| AvailableClass.as
|
+---lib
| | LibClass.as
| |
| \---com
| \---greensock
| | OverwriteManager.as
| | TimelineLite.as
| | TimelineMax.as
| | TweenAlign.as
| | TweenLite.as
| | TweenMax.as
| | TweenNano.as
| |
| +---plugins
where the Main.as class looked like this:
package
{
import flash.display.Sprite;
import com.greensock.TweenLite;
import LibClass;
import sub.AvailableClass;
/**
* ...
* @author Jason Merrill
*/
public class Main extends Sprite
{
private var _mySprite:Sprite;
private var _availableClass:AvailableClass;
/**
* Constructor
* @param duration the duration of the animation
*/
public function Main(duration:Number)
{
TweenLite.to(_mySprite, duration, { x:10, y:10 } );
TweenLite.to(this, duration, { x: -10, y: -10 } );
new LibClass();
}
public function get availableClass():AvailableClass {
return _availableClass; }
public function set
availableClass(value:AvailableClass):void
{
_availableClass = value;
}
}
}
I also included a second LibClass as a test. And as long os I didn't
include a variable ref like:
private var _lib:LibClass;
everything went fine, even when using the new LibClass();
My command line and result looked like this:
G:\tmp\jasonE:\flex_sdk\v3.2.0.3794\bin\asdoc.exe -doc-sources
G:\tmp\jason\src -strict=false -warnings=false
Loading configuration file
E:\flex_sdk\v3.2.0.3794\frameworks\flex-config.xml
Documentation was created in G:\dump\jason\asdoc-output\
Cheers,
Latcho
On 14-04-10 0:12, Merrill, Jason wrote:
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)
___
Flashcoders mailing list
Flashcoders@chattyfig.figleaf.com
http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
RE: [Flashcoders] ASDoc third party libraries
Thanks Jack, I'll check it out.
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 Jack
Doyle
Sent: Wednesday, April 14, 2010 12:07 PM
To: 'Flash Coders List'
Subject: RE: [Flashcoders] ASDoc third party libraries
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
RE: [Flashcoders] ASDoc third party libraries
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
RE: [Flashcoders] ASDoc third party libraries
I believe that won't work because 1) I already do that, and 2) ASDoc tries to include any classes that import third party classes. So you would have to comment out all the third party related aspects of your classes before compiling to ASDoc - more pain that it would be worth. Thanks for the idea though! 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 Ktu Sent: Monday, April 12, 2010 11:14 PM To: Flash Coders List Subject: Re: [Flashcoders] ASDoc third party libraries 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 ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
Re: [Flashcoders] ASDoc third party libraries
if your library is a .swc file, you should be able to just include it in
the -library-path without it being documented, like this:
-source-path ${build.working_root}/src
-library-path+=${build.working_root}/libs
in the case of source-based libraries, you could compile a .swc and link
to that in your code instead, then use the library-path for your docs.
(you also could ask the library developer to offer a .swc...seems like a
good thing to do.)
lower-level -doc-sources entries might do the trick too. e.g.,
-doc-sources /src/com/yourpackageA/ /src/com/yourpackageB/
instead of:
-doc-sources /src/
another option might be to explicitly list all your own classes in the
doc-classes, then set -exclude-dependencies to true.
i don't believe there's a way to exclude a package from docs.
sadly, asdoc is pretty primitive. i have a laundry list of feature
requests that i'll post here when i've entered bugs so people can help
vote them up.
colin
Merrill, Jason 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
RE: [Flashcoders] ASDoc third party libraries
Thanks Colin,
My library is not a .swc - it's a work-in-progress and other coders
contribute to it, though I suppose I could try and compile as .swc and
try that. The third party classes are things like Papervision and
TweenLite - they aren't going to offer me up a .swc most likely :) I
don't think they exist for those. The problem would remain for the main
library .swc though with the third party libraries being imported into
some of those classes thought, right?
another option might be to explicitly list all your own classes in the
doc-classes, then set -exclude-dependencies to true.
I have tried various forms of adding -exclude-dependencies in
FlashDevelop's Actionscript Documentation Generator, 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. But listing out all 50
or so classes - yeech! :)
I'll try some of your examples out and report back - thanks so much for
your reply.
Anyone know of any documentation generators that play better with AS
libraries (and ideally, though not necessarily, work with FlashDevelop)?
I've had the AS3 adapter for ZenDocs and NaturalDocs suggested to me
from someone on Flexcoders but haven't had time to try those out yet.
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
co...@moock.org
Sent: Tuesday, April 13, 2010 11:29 AM
To: Flash Coders List
Subject: Re: [Flashcoders] ASDoc third party libraries
if your library is a .swc file, you should be able to just include it in
the -library-path without it being documented, like this:
-source-path ${build.working_root}/src
-library-path+=${build.working_root}/libs
in the case of source-based libraries, you could compile a .swc and link
to that in your code instead, then use the library-path for your docs.
(you also could ask the library developer to offer a .swc...seems like a
good thing to do.)
lower-level -doc-sources entries might do the trick too. e.g.,
-doc-sources /src/com/yourpackageA/ /src/com/yourpackageB/
instead of:
-doc-sources /src/
another option might be to explicitly list all your own classes in the
doc-classes, then set -exclude-dependencies to true.
i don't believe there's a way to exclude a package from docs.
sadly, asdoc is pretty primitive. i have a laundry list of feature
requests that i'll post here when i've entered bugs so people can help
vote them up.
colin
Merrill, Jason 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
___
Flashcoders mailing list
Flashcoders@chattyfig.figleaf.com
http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
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
RE: [Flashcoders] ASDoc third party libraries
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
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
RE: [Flashcoders] ASDoc third party libraries
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
Re: [Flashcoders] ASDoc third party libraries
With this line. [Exclude(name=elementName, kind=property|method|event|style|effect)] Can you set say to ? [Exclude(NAME_OF_YOUR_CLASS, include=false)] Or something along those lines? Sorry if I am sending you to look for a needle in a hay stack. :) Karl On Apr 13, 2010, at 4:04 PM, Karl DeSaulniers wrote: 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
RE: [Flashcoders] ASDoc third party libraries
From what I've read, that tag is for properties AFAIK - not classes - so just where would you put the directive to exclude the entire class? Have you used ASDoc before? 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:24 PM To: Flash Coders List Subject: Re: [Flashcoders] ASDoc third party libraries With this line. [Exclude(name=elementName, kind=property|method|event|style|effect)] Can you set say to ? [Exclude(NAME_OF_YOUR_CLASS, include=false)] Or something along those lines? Sorry if I am sending you to look for a needle in a hay stack. :) Karl On Apr 13, 2010, at 4:04 PM, Karl DeSaulniers wrote: 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
RE: [Flashcoders] ASDoc third party libraries
It also says the Exclude metadata tag is for inherited elements, not imported class types. 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:24 PM To: Flash Coders List Subject: Re: [Flashcoders] ASDoc third party libraries With this line. [Exclude(name=elementName, kind=property|method|event|style|effect)] Can you set say to ? [Exclude(NAME_OF_YOUR_CLASS, include=false)] Or something along those lines? Sorry if I am sending you to look for a needle in a hay stack. :) Karl On Apr 13, 2010, at 4:04 PM, Karl DeSaulniers wrote: 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
Re: [Flashcoders] ASDoc third party libraries
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
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
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
Re: [Flashcoders] ASDoc third party libraries
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
Re: [Flashcoders] ASDoc third party libraries
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
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] ASDoc third party libraries
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
