ASDocs for Flex

How to plug ActionScript docs to Ctrl+Q action in editor?

0
7 comments
Quick documentation lookup (by default Ctrl+J on Mac and Ctrl+Q on other systems) is always enabled.
0
Avatar
Permanently deleted user

For example:
I have String.replace and want to check docs for standard class. Flex SDK created by Idea so it should be ok. But I see "No Documentation found"

0

When IDEA creates Flex/AIR SDK it configures its sources as well as swc files. And then looks for documentation in these sources. But there's no sources (and thus no documentation) for String class in standard Flex SDK installation. So you should open your SDK settings in Project Structure dialog, go to 'JavaDoc Paths' tab (rather confusing tab name for Flex SDK, isn't it? ) and specify documentation URL, for example http://livedocs.adobe.com/flex/3/langref/ or download these docs and specify path to your local directory.

0
Avatar
Permanently deleted user

Thanks!
There are many directories in Flex API docs and looks like I was using only wrong ones for my attempts...

0
Avatar
Permanently deleted user

Alexander,

Since I'm using maven's flexmojos, my Flex SDK is "compiler-3.3.0.4852.pom" rather than an IDEA create SDK configuration.  There is no where to configure the ASDoc on the settings for a Flex Compiler POM. Is this going to be added? Or would you like a JIRA requesting such?

Thanks,
Mark

0

When IDEA imports Flexmojos project it creates a bunch of libraries like "Maven: com.adobe.flex.framework:framework:swc:3.3.0.4852" and for each library it configures sources and docs as if they were in your local maven repositiry like: <repo>/com/adobe/flex/framework/framework/3.3.0.4852/framework-3.3.0.4852-sources.jar and <repo>/com/adobe/flex/framework/framework/3.3.0.4852/framework-3.3.0.4852-javadoc.jar  (oh, again javadoc instead of asdoc...). These jars do not exist in "standard" flexmojos repo but you may publish them yourself. Here's some info on this: https://issues.sonatype.org/browse/FLEXMOJOS-14. Once published all developers who import flexmojos projects in IDEA will have automatically configured sources and docs.

Another way is to manually configure each "Maven: *" library after importing. For example you may specify the url for docs for each library:

 
http://livedocs.adobe.com/flex/3/langref/ . Autoreimporting will not kill these custom settings.
0
Avatar
Permanently deleted user

Thanks Alexander! I was able to attach the documentation URL to the maven libraries. When I get some time I'll  install the flex files into our Nexus repository and see how that works. Thanks for the link to the information on how to do such.

0

Please sign in to leave a comment.