Help Wanted Producing Docs
I don’t have much experience at all with ASDoc but I could really do with some help producing the documentation for Efflex
Because Efflex utilizes other external projects when I try to create docs using ASDoc it wants to create documentation for these external projects as well. Excluding all these files one by one just isn’t feasible, can anyone help me with any other workarounds or automated process?
If so please leave me a comment below, your help would be much appreciated by myself and others that are using Efflex.
August 4th, 2009 at 12:08 am
I am not sure I understand your exact issue, but I was reading another blog and it may address your ASDOC setup issue. http://www.sebleedelisle.com/?p=401
August 5th, 2009 at 3:18 pm
Just use the doc_source parameter. I specifies which package you want to document. Asdocs gets as easy as pie with using this ant-script
http://labs.zeroseven.de/development/actionscript-development/asdoc-mit-ant-in-flexbuilder-eclipse/
August 8th, 2009 at 11:58 am
Hi Tink
The compiler arguments you need are -doc-sources for the files you want to include and -library-path for the dependent libraries that shouldn’t be documented.
For automation, take a look at the ant build script in Flint (build.xml). It excludes docs for Papervision3D and Away3D despite depending on the classes. If you need a hand understanding it let me know, I’d be happy to talk through it with you. The asdocs compile is at the end of the file (after compiling the library and all the examples).
Richard
August 16th, 2009 at 12:24 pm
Hi there,
I am having problems compiling the source (I took it from SVN trunk).
It gives me errors on the lines containing like Vector.
What am I doing wrong?
I am using Flex 3
August 16th, 2009 at 9:07 pm
There are classes in the library that are built for Flex 4 and leverage some of the additions to Flash Player 10, Vector being one of them.
The easiest way to use Efflex is to link the raw source to a project. You’ll then only get errors with classes you are using.
August 17th, 2009 at 12:19 pm
That might be a stupid question… how do I “link” the source in that way?
August 17th, 2009 at 12:25 pm
Download the source to a folder, right click on the project you want to use it in, select properties, Flex Build Path, Source Path, click Add Folder and select the folder you download the source to.
August 17th, 2009 at 3:31 pm
my experience with Flex 3 and ASDoc … http://blog.lyraspace.com/2008/12/02/developing-flex-with-asdoc-in-mind/
August 28th, 2009 at 1:07 pm
http://flexandpersonal.blogspot.com/
Maybe this post could help you!!
September 16th, 2009 at 7:06 pm
Hello everybody
I have checked out the source from svn and i am trying to build a swc out of it in both flex builder and command line but i am having issues.
Does anyone have a tutorial on how to compile it?
or build.xml?
or a build script?
thanks!
Neven
September 16th, 2009 at 7:11 pm
The easiest way is to use the raw source and link it to your project as a source path, or put the code in the libs folder. This will mean that only external libraries used by the effects you use will be required.
To successfully compile it into a SWC you would have to include all 3 of the current external libraries (Papervision3D, Away3D, Flint), and exclude code if your not using Flex 4 and Flash Player 10.
In fact I’m repeating myself here, as you see I said the exact same thing in the comments above.
September 16th, 2009 at 8:55 pm
Yeah that sounds even more complicated as I do not have the external projects. Basically I am trying to create a new swc file because the one they have offered for download does not have some of the effects such as
FlipPapervision3DTile and some others listed in http://www.efflex.org/EfflexExplorer.html
why is that? Can someone produce a new swc for flex 3 ?
thanks for your help!,
Neven
October 26th, 2009 at 9:25 am
Hi Tink
If you like, send me an email and ill send you a copy of an ASDoc shell script i used for documenting a project.
best,
D.
November 23rd, 2009 at 3:53 pm
hi tink,
is there a bug in your old efflex.swc?
when i use the following code, i have problems with the first viewstack.
when i remove the labels inside the viewstack it is ok.
when i remove the effect, it works too..
greez
uli
<![CDATA[
import mx.controls.*;
import org.efflex.viewStackEffects.*;
import mx.containers.*;
private var indEX:Number = 0;
/*
private function clicker(idObj:String):void{
viewStack.selectedChild = this["idStart"];
}
*/
private function vorcheck():void{
if(viewStack.childDescriptors){
if(indEX = viewStack.childDescriptors.length-1){
vorw.visible = false;
indEX = viewStack.childDescriptors.length-1;
}
else vorw.visible = true;
}
else{
vorw.visible = false;
zur.visible = false;
}
}
private function vor():void{
indEX++;
vorcheck();
var nr:String = “id”+ (indEX);
viewStack.selectedChild = this[nr];
}
private function zurueck():void{
indEX–;
vorcheck();
var nr:String = “id”+ (indEX);
viewStack.selectedChild = this[nr];
}
]]>
November 23rd, 2009 at 3:55 pm
sorry, here is the rest of the code…
December 9th, 2009 at 1:27 am
thanks for shared,it is a nice tool,but can you make a air EfflexExplorer,such as Tour de Flex,it would be very helpful to learn to use this component.
thanks very much!
December 30th, 2009 at 4:58 am
What’s the status of this project? There seems to be recent activity on the Google Code page but I couldn’t find any sample code anywhere. Is development continuing? It seems to have a conflict with FlashBuilder? Are you still looking for someone to help with docs?
December 30th, 2009 at 10:01 am
Hi David
The project is ongoing mate in my spare time.
You can find sample code by right clicking on the examples and selecting ‘view source’.
http://www.efflex.org/category/orgefflexmx/
http://www.efflex.org/category/orgefflexmxdatastackeffects/
http://www.efflex.org/category/orgefflexmxpairviewstackeffects/
http://www.efflex.org/category/orgefflexmxviewstackeffects/
http://www.efflex.org/category/orgefflexsparkviewstackeffects/
I will get round to some documentation one day!
If you check out the source it should work fine in FB.
January 1st, 2010 at 1:30 am
Tink,
Thanks so much for the links! These effects are great!
Dave
January 11th, 2010 at 11:52 pm
Hi i have import efflex into github -> http://github.com/FrancisVarga/flexEfflex
best regards
February 3rd, 2010 at 9:23 am
Hi I have already asked this but my question seems to have disappeared .I can only get the effects to work if I select “merged with code” in the compiler settings of fp3. If I try to use a RSL I get a blank screen. Anyone else have this?
February 4th, 2010 at 11:39 am
I generally don’t use the SWC instead using the source code itself. The SWC was compiled by someone else.
Maybe you could take the source, compile it for you own needs and send the SWC back to me so I can add it to the google code project?