ASDoc @includeExample

We have been referencing the fl.controls package extensively
for ASDoc commenting lately and one tag has me a little confused,
the "@includeExample" tag seems pretty straight forward but I
haven't been able to get it working properly. I noticed it was left
out of the tags specified here (
http://livedocs.adobe.com/flex/3/html/help.html?content=asdoc_6.html).
My question on using the @includeExample tag comes down to two
things really.
A) Does the included .AS file need any special comments or
formatting?
B) Should this .AS file be placed within my source directory,
or can it be placed outside in an examples folder?
Thanks
-justen

I found out that ASDoc is used with Flex classes. For it to find the fl.controls classes you have to include the path to an swc that has the componentShim in it.
there is a parameter that has to be added.
-lib-path myExported.swc
It reads the classes that are within the swc.

Similar Messages

[svn] 3968: Fix for - ASDoc fails if example code included by the @ includeExample tag contains an "&"

Revision: 3968
Author: [email protected]
Date: 2008-10-30 10:45:04 -0700 (Thu, 30 Oct 2008)
Log Message:
Fix for - ASDoc fails if example code included by the @includeExample tag contains an "&"
Also fix for broken links with $$ symbol.
QE Notes: None
Doc Notes: None
Bugs: SDK-17830
tests: checkintests
Ticket Links:
http://bugs.adobe.com/jira/browse/SDK-17830
Modified Paths:
flex/sdk/trunk/modules/compiler/src/java/flex2/compiler/asdoc/AsDocUtil.java
flex/sdk/trunk/modules/compiler/src/java/flex2/compiler/asdoc/TopLevelClassesGenerator.ja va

Revision: 3968
Author: [email protected]
Date: 2008-10-30 10:45:04 -0700 (Thu, 30 Oct 2008)
Log Message:
Fix for - ASDoc fails if example code included by the @includeExample tag contains an "&"
Also fix for broken links with $$ symbol.
QE Notes: None
Doc Notes: None
Bugs: SDK-17830
tests: checkintests
Ticket Links:
http://bugs.adobe.com/jira/browse/SDK-17830
Modified Paths:
flex/sdk/trunk/modules/compiler/src/java/flex2/compiler/asdoc/AsDocUtil.java
flex/sdk/trunk/modules/compiler/src/java/flex2/compiler/asdoc/TopLevelClassesGenerator.ja va

[svn] 3275: Initial check in for support for asdoc comments in mxml files.

Revision: 3275
Author: [email protected]
Date: 2008-09-19 15:01:57 -0700 (Fri, 19 Sep 2008)
Log Message:
Initial check in for support for asdoc comments in mxml files.
For adding comments at the class level or to properties defined inside mxml use the syntax
Other tags supported in asdoc should also work. for example @see, @includeExamples etc.
QA: Yes
Doc:
Reviewed By: Paul
Tests: checkintests
Modified Paths:
flex/sdk/trunk/modules/compiler/src/java/flex2/compiler/asdoc/AsDocAPI.java
flex/sdk/trunk/modules/compiler/src/java/flex2/compiler/asdoc/TopLevelClassesGenerator.ja va
flex/sdk/trunk/modules/compiler/src/java/flex2/compiler/mxml/ImplementationCompiler.java
flex/sdk/trunk/modules/compiler/src/java/flex2/compiler/mxml/ImplementationGenerator.java
flex/sdk/trunk/modules/compiler/src/java/flex2/compiler/mxml/InterfaceCompiler.java
flex/sdk/trunk/modules/compiler/src/java/flex2/compiler/mxml/MxmlCompiler.java
flex/sdk/trunk/modules/compiler/src/java/flex2/compiler/mxml/builder/AbstractBuilder.java
flex/sdk/trunk/modules/compiler/src/java/flex2/compiler/mxml/builder/DocumentBuilder.java
flex/sdk/trunk/modules/compiler/src/java/flex2/compiler/mxml/dom/MxmlScanner.java
flex/sdk/trunk/modules/compiler/src/java/flex2/compiler/mxml/dom/Node.java
flex/sdk/trunk/modules/compiler/src/java/flex2/compiler/mxml/gen/ClassDef.vm
flex/sdk/trunk/modules/compiler/src/java/flex2/compiler/mxml/rep/Model.java
flex/sdk/trunk/modules/compiler/src/java/flex2/compiler/mxml/rep/MxmlDocument.java
flex/sdk/trunk/modules/compiler/src/java/flex2/compiler/mxml/rep/decl/PropertyDeclaration .java
flex/sdk/trunk/modules/compiler/src/java/flex2/compiler/mxml/rep/decl/UninitializedProper tyDeclaration.java
flex/sdk/trunk/modules/compiler/src/java/flex2/compiler/mxml/rep/init/ValueInitializer.ja va
flex/sdk/trunk/modules/compiler/src/java/flex2/tools/ASDocConfiguration.java
Added Paths:
flex/sdk/trunk/asdoc/templates/images/AirIcon12x12.gif
flex/sdk/trunk/modules/compiler/src/java/flex2/compiler/util/MxmlCommentUtil.java

@John - no luck on the plugin angle. In checking both JDev installs that previously had the problems, they have the default extensions.
@Dave - at the time I can't say we noticed any migration notices, we certainly didn't see the migration dialog though. However the application in SVN was built on the same version of JDev so I don't expect a migration to find any changes anyhow.
However on your second point we always check out into an empty directory, as we're checking out the whole application. As such if as you say the migration utilities is always called, shouldn't that mean we always see the projects modified? We certainly don't, we're on a day by day basis checking out whole applications to different directories and we don't see that behaviour.
In turn reconsidering the modified .jpr file, from what I saw it looks to me that the whole project file is re-set to it's original state. Initially the problem detected was the libraries attached to the project were gone so we couldn't compile, but in close inspection it seems the whole .jpr file has been modified to a rather vanilla setup.
One thing I can say when we originally experienced the problem (and from memory this was true in the dim dark past when it also occurred another time), is it was a check out from a SVN tags directory, not the trunk. In thinking about it, it may be the first check out from the tags directory that we see the issue. However to get around the issue we just revert the project file in the tags directory, we don't actually change the SVN repository code (ie. commit), so the issue should keep occurring. Yet at the moment if we check out the same tags directory, the issue doesn't occur?
Hmmm?
Btw Dave, are you an Oracle employee?
CM.

[svn:osmf:] 16068: Update @includeExample to add symbolic "examples" relative path (that is expanded by the build process).

Revision: 16068
Revision: 16068
Author:   [email protected]
Date:     2010-05-12 11:17:11 -0700 (Wed, 12 May 2010)
Log Message:
Update @includeExample to add symbolic "examples" relative path (that is expanded by the build process).
Also added -noswf option as we are not compiling the example into a swf for the asdocs.
Modified Paths:
    osmf/trunk/framework/OSMF/org/osmf/media/MediaPlayerSprite.as

Remember that Arch Arm is a different distribution, but we try to bend the rules and provide limited support for them. This may or may not be unique to Arch Arm, so you might try asking on their forums as well.

[svn] 4128: Fix for - Examples imported by the @ includeExample tag are truncated after the first or second XML comment

Revision: 4128
Author: [email protected]
Date: 2008-11-17 12:53:34 -0800 (Mon, 17 Nov 2008)
Log Message:
Fix for - Examples imported by the @includeExample tag are truncated after the first or second XML comment
examples-path option is now public and adding period at the end of Constructor.
QE Notes: baselines need to be updated.
Doc Notes: None
Bugs: SDK-18125, SDK-18077, SDK-18126
tests: checkintests
Ticket Links:
http://bugs.adobe.com/jira/browse/SDK-18125
http://bugs.adobe.com/jira/browse/SDK-18077
http://bugs.adobe.com/jira/browse/SDK-18126
Modified Paths:
flex/sdk/trunk/modules/compiler/src/java/flex2/compiler/asdoc/TopLevelClassesGenerator.ja va
flex/sdk/trunk/modules/compiler/src/java/flex2/configuration_en.properties
flex/sdk/trunk/modules/compiler/src/java/flex2/tools/ASDocConfiguration.java

I have the same problem except almost every song I bought from Itunes has this problem. Not only that, but somehow some of the music, about $125 worth has been deleted form my 3 back up discs. This is only happening with my purchases and not any songs I uploaded from cd. How on earth did this happen, and how did it wipe clean 3 different back ups? I have found some of the music where it belongs, but like I said some of them are gone, gone, gone. I run three different back ups and they are on 24/7. Where is all of this music? I still have it on my ipod, but it will not load back into itunes the way purchases used to. Some of the music is purchased straight to my ipod touch, but shouldn't i be able to reload them into itunes? I spent 3 hours going 1 song at a time reloading them from their original location. But I cannot locate about $125 worth of music that I purchased from itunes. I have 6 macs in my family and preach the good news to all who will listen about hows macs are flawless. Now I have egg all over my face and have thrown away a nice sum of money on missing music. Please help!

[svn:fx-trunk] 16098: Fix for issue where @ includeExample tag to an MXML file casues a compiler error.

Revision: 16098
Revision: 16098
Author:   [email protected]
Date:     2010-05-13 12:47:41 -0700 (Thu, 13 May 2010)
Log Message:
Fix for issue where @includeExample tag to an MXML file casues a compiler error. The issue was caused due to improper closing of comment in mxml file. With this fix ASDoc does not short circuit in such a scenario, instead it logs that into validation_errors.log
QE notes: None
Doc notes: None
Bugs: SDK-26380
Reviewer: Darrell
Tests run: checkintests
Is noteworthy for integration: No
Ticket Links:
    http://bugs.adobe.com/jira/browse/SDK-26380
Modified Paths:
    flex/sdk/trunk/modules/compiler/src/java/flex2/compiler/asdoc/TopLevelClassesGenerator.ja va

Hi _spoboyle,
Yes i have seen that message before which gave me a few things to test out but to no avail. I am setting the data channel port between 45000-50000 as per the post you suggested and the data channel Port being assigned in my code is between those numbers. I have also set my firewall to open ports 45000-50000 to test to see if that was the issue as I hadnt done that previously but I get the same problem.
The actual file get placed on the FTP server as well, it pauses as if its trying to send the data but then just give me the socket error message.....frustrating!!
Im running out of ideas

Using asdoc to generate documentation: google analytics?

I'm using the asdoc.exe program that came with Flex Builder 3 to generate documentation for FlashMOG. I want to put in my google analytics javascript before the closing body tag of each file. Is there some way to get asdoc to do this?

The asdoc tool allows you to supply your own templates; you could probably include that in there: http://help.adobe.com/en_US/flex/using/WSd0ded3821e0d52fe1e63e3d11c2f44bc36-7ffa.html

[svn:fx-trunk] 11454: ASyncList class ASDoc change: added explicit warning about the lack of support for re-inserting pending items .

Revision: 11454
Author:   [email protected]
Date:     2009-11-04 18:17:33 -0800 (Wed, 04 Nov 2009)
Log Message:
ASyncList class ASDoc change: added explicit warning about the lack of support for re-inserting pending items.
QE notes:
Doc notes:
Bugs:
Reviewer:
Tests run:
Is noteworthy for integration:
Modified Paths:
    flex/sdk/trunk/frameworks/projects/framework/src/mx/collections/AsyncListView.as

Question about the use of asdoc

I want to use asdoc to compile the flex SDK documentation myself. The reason is I need it in another format, and for a specific SDK (4.5.1).
I simply cannot get it to run. Out of the box, what should the command line look like if I'm in the bin the bin folder? Everything I try just keeps throwing errors.

1002099 wrote:
+"When an application completes, you need to close any connections that you have created. Failure to close a connection can cause resources not to be released by the JMS provider. Closing a connection also closes its sessions and their message producers and message consumers.+
+queueConnection.close();+
+topicConnection.close();+
+Before your application can consume messages, you must call the connection's start method; for details, see Section 3.5, "Message Consumers." If you want to stop message delivery temporarily without closing the connection, you call the stop method."+
Should I close the connection as the last paragraph say?. If so, I don't know how to do it without lose the service, because if I call "close" method on the connection and immediatelyi start it, i will lose all my consumers and producers for a little time.
You should close a connection when you have no further use for it as this will release resources.
You must start a connection if you want to receive messages from it.
Most applications don't use stop(). However if your application needs to temporarily pause delivery of messages (to the application) for some reason, call stop(). When your application wants delivery of messages (to the application) to restart, call start() again.
Nigel

ASDocs - Preventing style and tags removing from HTML

Hi,
I am using Flex 4 ASDoc
When I write in my comments:
<span class="myClass">whatever</span>
entire tag including text is removed (myClass is present in style.css)
When I write:
<span style="color: #FF0000;">whatever</span>
style attribute is removed.
I have a feeling this has something to do with xslts and other setting. Can someone point me to the files where changes can be made so that custom styles and classes are not processed/removed?
Thank you.

bump it up.

[svn:fx-trunk] 7784: adding xslt change so info related to Alternative shows up in the asdoc

Revision: 7784
Author:   [email protected]
Date:     2009-06-12 07:46:21 -0700 (Fri, 12 Jun 2009)
Log Message:
adding xslt change so info related to Alternative shows up in the asdoc
QE Notes: None.
Doc Notes: None.
Modified Paths:
    flex/sdk/trunk/asdoc/templates/class-parts.xslt
Added Paths:
    flex/sdk/trunk/asdoc/templates/images/P_AlternativeMetadataIndicator_30x28_N.png

I've checked the resolution in Photoshop just as a double-check and it shows resolution as 300 PPI. When you say "because they can be mixed" do you mean because elements and graphics with the PDF can be of varying resolutions? I hadn't thought of that, if that's what you meant. I do have some items within my pdf that might be lower resolution.
If these show up in my Preflight Panel as an issue, does this mean they would be flagged also with the Printer? In trying to find a resolution I read several forum discussions about how Printers often run your document through a Preflight process and will send it back when there are low resolution images in the document.
Is there some other way to be sure these images are in the InDesign document as 300 PPI so I can know they will in fact print correctly?
PS - Peter - thanks for the super quick response! And I saw your the highlighted "Exceptional Contributor" on the right sidebar for the InDesign forum - clearly well-deserved! Congrats

Problem with running ASDocs in FB3

I'm trying to use ASDocs with my current project, but I can't seem to get the comments for MXML components to show up. The comments inside the <mx:Script> tag work fine. Any ideas?
Also, I'm receiving this error when I run ASDocs:
[Deprecated] Xalan: org.apache.xalan.res.XSLTErrorResources_en_US
Any help would be greatly appreciated.

Has anyone seen this before? Any help would be greatly appreciated.

Flash builder 4.7 as plugin won't display asdoc

Hi,
on windows 7 x64, I just installed Flash Builder 4.7 x64 on my existing eclipse 4.2 x64 (using "the Adobe Flash Builder 4.7 Plug-in Utility") and the asdoc popup won't display anything but the current element. If I start the standalone Flash Builder, using the same workspace and same project, it works fine. Do I need to configure something else so it works as a plugin?

My mistake...
There was a typo into the XML application descriptor, that prevented the app to install properly on the device.
Precisely, it wasn't a typo but raher a malformed <intent-filter> node. I launched adb tool from the console with adb install MyApp.apk command, and I saw this : Failure [INSTALL_PARSE_FAILED_MANIFEST_MALFORMED] in the terminal. From here it was easy to find the culprit.
What would be cool is to have this feature inside the Flash Builder's Console panel.

Bug in new asdoc rules in Flex PMD 1.1

ASDoc rules failing when there is metadata between asdoc comment and attributes/methods/classes
https://bugs.adobe.com/jira/browse/FLEXPMD-167

Hi Clint,
The AsDoc node was "attached" to the metadata node instead of the attribute, method, or class node.
The bug has been fixed on trunk.
Best
Xavier

ASDoc with external swc

I need to generate the documentation from a project using
ASDoc. The problem is that the project includes some classes from
an swc library for which I don't have the source code.
the command that I am running is:
asdoc -source-path src -doc-sources src
-external-library-path+= c:\'Program Files'\MDM\'MDM Zinc
v2.5'\swc\mdm.swc
If I add the option to -exclude-classes I get the following
error:
"default arguments may not be interspersed with other
options"
Help would be very much appreciated.

Hello! I'm also working with an external SWC created by Flash
CS3 which only contains exported graphical assets like logos and
stuff.
Within Flex I simply load the according SWF file and have
full access to these assests. (Added the SWC as external library
path).
So now I wanted to export my classdocumentation using ASDoc
but this fails because ASDoc throws an error like: Type was not
found (no compile time constant).
Within the SWC there's only a catalog.xml which seems to
represent all the contents within the SWF, but ASDoc doesn't
recognise this contents.
Is there a way to create sourcecode out of the
catalog.xml?

ASDoc @includeExample

Similar Messages

Maybe you are looking for