AsDoc Task with Flex 4 SDK

viatropos

unread,

Jun 21, 2009, 9:32:25 PM6/21/09

to ProjectSprouts

Hey Luke,

What are the steps required to creating documentation with your AsDoc
task? I've been at it for a few hours trying to use the Flex 4 SDK
and I'm not getting anywhere... Thanks man.

Lance

Luke Bayes

unread,

Jun 22, 2009, 1:42:40 AM6/22/09

to project...@googlegroups.com

Hey Lance,

I'm a little unclear about what you're asking. Are you trying to generate documentation _for_ the Flex 4 SDK, or _with_ it?

If you're trying to set up asdoc for your own custom project, you can use the asdoc task directly, or the 'doc' helper task. You should be able to use Sprouts to create a new as3 project, copy the generated rakefile into your (hopefully vanilla) Flex project, update the Project Model configuration as needed and run:

rake doc

Some updates that will be likely are:

1) Uncomment the block regarding the compiler version.

2) Change the 'libs' folder name to 'lib' - either in the file system or the rakefile

3) Be sure to add .class_path << '[path]' for any additional class paths your project uses.

Let us know if you have any issues getting there.

Thanks,

Luke

viatropos

unread,

Jun 22, 2009, 3:17:52 AM6/22/09

to ProjectSprouts

Thanks for the quick reply!

I'll try the things you're saying, but here's another question: Is
there a way to just say "use this flex sdk somewhere over here to do
all the work, instead of the sprout gem?"

I'm getting this error because I think the adobe site is down:

rake aborted!
[ERROR] Failed to load file from: 'http://flexorg.wip3.adobe.com/
flexsdk/4.0.0.3151/flex_sdk_4.0.0.3151.zip'
[REMOTE ERROR] <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
<HTML><HEAD>
<TITLE>404 Not Found</TITLE>
</HEAD><BODY>
<H1>Not Found</H1>
The requested URL /flexsdk/4.0.0.3151/flex_sdk_4.0.0.3151.zip was not
found on this server.<P>
</BODY></HTML>

Plus I'm using Flex 4.0.0.7605 for my projects, so maybe there's a way
to customize that?

Any ideas?

Thanks man,

Lance

On Jun 21, 10:42 pm, Luke Bayes <lba...@patternpark.com> wrote:
> Hey Lance,
> I'm a little unclear about what you're asking. Are you trying to generate
> documentation _for_ the Flex 4 SDK, or _with_ it?
>
> If you're trying to set up asdoc for your own custom project, you can use
> the asdoc task directly, or the 'doc' helper task. You should be able to use
> Sprouts to create a new as3 project, copy the generated rakefile into your
> (hopefully vanilla) Flex project, update the Project Model configuration as
> needed and run:
>
> rake doc
>
> Some updates that will be likely are:
>
> 1) Uncomment the block regarding the compiler version.
> 2) Change the 'libs' folder name to 'lib' - either in the file system or the
> rakefile
> 3) Be sure to add .class_path << '[path]' for any additional class paths
> your project uses.
>
> Let us know if you have any issues getting there.
>
> Thanks,
>
> Luke
>

Luke Bayes

unread,

Jun 22, 2009, 9:07:33 PM6/22/09

to project...@googlegroups.com

Yeah -

We *really* need to get this thing set up to use environment vars, but since that's not yet released, the quickest way to use your own SDK is to either copy or symlink it into the sprout cache.

Depending your operating system, Sprouts attempts to store downloaded files here:

* OSX /Users/foo/Library/Sprouts/cache/0.7

* Windows C:/Documents And Settings/foo/Local Settings/Application Data/Sprouts/cache/0.7

* Linux ~/.sprouts/cache/0.7

Within that folder, you'll need to create a set of folders like:

sprout-flex3sdk-tool-3.3.0/archive/*

sprout-flex3sdk-tool-3.3.0/flex_3_sdk.zip

The zip file can be anything (even a text file) as long as it's the correct name, and the archive folder should contain your complete SDK - like 'bin, lib, frameworks, etc'.

This will essentially force sprouts into thinking that it has already downloaded the SDK and it will use whatever is in those folders. If they've exposed some advanced features in the Flex 4 compiler, you may run into trouble, but that should get you going.