I've started using ASDoc to document my latest project. But for some reason, it will only document one package function per package. This means that it documents one function in my utils package and then skips all the others.
Has anybody here successfully documented a utils-like package, with a ton of package functions?
I'm running into this weird thing with ASDoc. It will only document one package function per package.For example.I have these two functions:
gs.util.printf
gs.util.ftrace
In these files:
gs/util/printf.as
gs/util/ftrace.as
The only function that get's documented in ASDocs is "printf". But I know it can do more than one. As an example, in the livedocs [URL] There are more than one functions documented.
I want to add a comment to some elements in a Flex document, and process the comments using ASDoc. I can easily do this for the script portion, but I end up with a ton of ugly "This property can be used as the source for data binding." messages for each element I declared in Flex. Is there any way to embed a comment into a flex element so that it can be read by ASDoc? I have tried using the standard
<!-- -->
notation, but that didn't seem to work.
EDIT: The notation seems to be swallowed up as an HTML comment..
Is it normal for the document class to be in the default package, or is this just a bad habit I'm in?
View 2 RepliesI've got a movie clip which i "exported for actionscript" inside of the properties dialog.this is the code inside of the package that was created to go along with it (MovieClipName.as)[code]...
View 6 RepliesI am trying to set up a .as package to handle all my rollover functions for my _mc's that are acting as buttons in my fla file.
Here is the code I have .
package
{
import flash.display.MovieClip;
import flash.events.Event;[code]....
I just started using AS3 and I am not all that familiar with the new updates to the code.I keep getting this error message.1119: Access of possibly undefined property onEnterFrame through a reference with static type btnEffect.
Are custom functions that are defined at the "default" package level (aka Top Level) included in a compiled SWC? Or are they ignored?
//Compiled, or not to be compiled in a SWC - that is the question...
package {
public function topLevelMethod():void {
trace("Hello World");
}
Anyone experienced problems with this?
It seems I have no trouble pointing an FLA's document class to my project's class package when the FLA is at the same root level as the package's top-level directory. However, if the FLA is nested in a sub-directory, then relative paths to a class nested in the package will not work.example package & class location : [url]....
Case1 :
Package location : MyProject
FLA location : MyProject[code]........
If someone can provide an explanation as to why nested FLAs can't point to custom packages in parent-level directories, OR demonstrate how this can be done,
When I create anything in a library, it's basically a class right? Meaning I can do essentially the same thing with use of a package in an AS file? In AS 2.0 this would probably mean I can add specific functions on this class as I can do when I use flash's object interface and add script to the specific class object itself. However, in AS 3.0 you cannot attribute code directly to an object right?
This leads me to my second question. I basically want to create a flash mp3 player (I've coded this already), but make it so that it is an entire package of contents, so I can add it to my website when a mouse event is detected and then take it off the website once it's no longer needed (to conserve memory and assure an overall nice experience). The problem is that I have many objects and subsequent functions (play button, pause button, etc), and want all of this to be contained in one file. Is this even possible?
I have this Class:
package {
import flash.display.MovieClip;
public class MainClass extends MovieClip {
[Code]....
I had used it as a document class, when I call the sum function from the main time line it works, but I need to call it from inside a movieclip.
Call functions from document class?
View 11 RepliesMain is my doccument class . How can i call Main.showAlert function from Caller class.[code]...
View 5 RepliesI've been away from this forum for a couple of years but finally found the time to dig into AS3. Glad to be back (although motivated by frustration)
I have a main document (Main.fla), linked to a document class named "Main" in the AS-3-settings dialog box, but named "Main.as" on my harddrive.
I also wrote a simple tracing action and saved it as "xTrace.as"[code]...
How do I acsess public var/functions in the document class?
View 7 RepliesI have 3 functions in my main document class that I want to execute when the main timeline reaches a particular frame number. how do I do that? see the code and comments
[Code]...
I am having troubles passing an x and y argument into a package function that creates a projectile on stage at the tank.gun's x and y.I have attached a zip of the code I am working on.[code]
View 6 RepliesI need to execute some javascript string code from flash swf file using actionscript 3.
I read that it could be done by passing the javascript code to the parent html document , using externalinterface.call function. Then I assume it will be faster if I can declare functions in the javascript code in the HTML document in the first use of externalinterface.call funtion ; if flash code calls the javascript code repeatedly. So let me ask you how to do that. For details , any javascript to be loaded is unknown in design time and I can not prepare a javascript file to be loaded.
I have 3 functions in my main document class that I want to execute when the main timeline reaches a particular frame number. how do I do that?
see the code and comments
public function mainClass()
{
//stage declaraction
stage.align = StageAlign.TOP_LEFT;
[Code]....
Main is my doccument class . how can i call Main.Caller
package { import flash.display.Sprite; import flash.events.Event;
public class Main extends Sprite {
public function Main():void { if (stage) init(); else
[Code]....
I have an actionscript file,it has a package name,it locate C:demo directory,like follows:
package demo{
import flash.display.*;
public class ABC extends Sprite{[code]............
Then I compile above code like following command,but it raise following error:
C:>mxmlc demoABC.as
Loading configuration file C:sdkframeworksflex-config.xml
C:demoABC.as: Error: A file found in a source-path must have the same package structure '', as the definition's package, 'demo'.Where is wrong above command?
This is with Flexbuilder 3.2, Eclipse 3.3.2.I am moving my development environment to a new machine. Actionscript classes that compiled in the old environment now get a compile error:
A file found in a source-path must have an externally visible definition. If a definition in the file is meant to be externally visible, please put the definition in a package.I do declare the package in these classes - I think failure to declare the package is the usual reason for this error.To add to the mystery, many classes in this project compile without errors.
Does anyone know if you can write your own pages that asdoc will recognize and use? For instance, I'd like to write some "Getting Started","Support" and "FAQ" kind of pages that will help understanding what my actionscript classes are about.
View 2 RepliesDoes anybody know of a tool that will allow me to create ASDoc style documentation with a Flash CS4/AS3 application? From what I hear ASDoc only works with Flex.
View 2 RepliesMy operation system is Window XP in Chinese. I'm running flex sdk > asdoc in command line. Asdoc picks up the system default language. How can I force it to be run in English language environment?
View 1 RepliesIs it possible with ASDoc to include example MXML code in your comment?[code]
View 2 RepliesHow do you add sample xml to asdoc function/class comments in Flex? They can obviously be added, but they wont show in the hover asdoc comments in Flash Builder 4. [code]...
View 1 RepliesI have a canvas based component, so when I check the asdoc comments, they have inherited comments of Canvas. can we remove that inherited comments, and add our own AsDoc comments..
View 1 RepliesI'm finally reading up on commenting code with ASDoc (http:url]....) but the way ASDoc is set up doesn't seem to agree with the way I write my getter/setters.Here is how I write them:
Code:
//I want to add the ASDoc tags here, before this chunk of code
private var _enabled:Boolean = true;
public function get enabled():Boolean[code]...
if I ad the tags where I want them, if I understand correctly, they will comment the private variable instead. Bummer.So, either I change the coding style I have been using for the past three years, or insert the tags inside of my code, making it ugly and less structured. I'm leaning towards option A.how do YOU write your getter/setters so they are ASDoc friendly?
I could sift through all HTML pages and write code that extracts the information, or even start from scratch and do the same for AS files, but I'd rather not.
I would like to use the ASDoc information from one set of classes in another SWF. Is there any way to export all the ASDoc information to XML format, or something that is easy to parse?
Such as:
Code:
<class name="DebugText" description="A lightweight, visual debugging tool." author="IqAndreas">
<property name="text" namespace="public" returns="String" throws="Error bla bla"
[Code]....
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?
View 2 Replies
