Flex :: ASDoc In Create Documentation For Packages/namespaces?
May 18, 2009As the title says - is it possible to document my ActionScript packages / namespaces using the ASDoc comments and the included asdoc command line tool?
View 1 Replies
Similar Posts:
Documentation - Flash CS4 Have An Alternative To ASDoc?
Mar 16, 2010Does 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 RepliesActionScript 3.0 :: Namespaces And Packages - Fail To Reference As-class From Fla File
Sep 26, 2009Trying to migrate to AS 3.0 here, but are facing a tough time at kick-off: I have a base fla file located in a folder named "game". The "game" folder is in a folder named "northcreek" which again is in a folder named "no". For no other reason than that I read somewhere that this was smart. Anyway, I have in my (document) class under publish settings this: no.northcreek.game.Engine Both my "game.fla" and my "Engine.as" reside in the "game" folder, but I fail to reference my as-class from my fla file. What do I do wrong? It works if I simply remove all namespace names, and only type namespace, but I am trying to do it the right way here...
View 8 RepliesActionscript 3 :: Writing Documentation - Creating Online Documentation?
Jun 17, 2011I've been working on a framework in AS3 that I want to release, but first I obviously need to prepare some documentation for it.I've noticed that quite a few sites have the exact same layout, functionality etc as Adobe Livedocs, which has let me to believe that there's something open source out there for creating online documentation.
Ideally the system would be specifically suited for documentation in ActionScript 3. I don't have a requirement in terms of the documentation being automatically generated either - if there's something out there that looks/works nice I'm happy to manually create the documentation (provided it comes with tools for easily adding classes, arguments, etc).
ActionScript 3.0 :: Best Way To Create Clean Documentation?
Feb 4, 2009I've been trying to clean and organize my code as much as possible lately and I'm wondering what the best way is to create documentation that resembles the professional ASDocs.
View 4 RepliesActionScript 3.0 :: Error Importing Create A Reusable Class. Documentation
Jan 3, 2009I am trying to create a reusable class. documentation says to use as package name the directory structure.
in directory C:JJGFlashSourceRF
i have a class in a package called "package
C.JJG.FlashSource.RF {"
in my test flash file I have "import C.JJG.FlashSource.RF;"
I also tried import JJG.FlashSource.RF;
Flex :: 3 - What Does Different Namespaces Mean
May 17, 2011I worked on a flex application 6-7 months back. We used flex 3.5 sdk. Now we are upgrading our flex app with flex sdk 4/4.1 I am still new to flex development and I have a very basic question related to namespace. I have seen three different namespaces in flex sample applications. What is the purpose of having three diff namespaces? When do I use each of them ?
[Code]...
Flex :: Dealing With Namespaces In E4X
Dec 14, 2011I'm trying to get data from a namespaced xml file in a flex app. There is a root namespace (xmlns="blah") and another namespace (xmlns:i="blah"), and I'm able to access most tags using the following:
var ns:Namespace = doc.namespace();
var result:XMLList = doc.ns::element;
However, there are several tags that are subject to change in the application, and i'd like to not hardcode them, possibly using the elements method:
var result:XMLList = doc.elements(configuredField);
Is there a way to get elements with namespaces using the elements method, or a similar way to get XML elements in flex using a parameter?
Actionscript 3 :: Learning Flex 4 With Namespaces?
Jul 8, 2011I am trying to learn flex4 from adobe document and I am very confused while using three namespaces.. there is no way i can keep track of when to use what often ending up using fx inside mx or s or similarly making some stupid goofed up combinations of {fx,mx,s}.
Adobe document is huge and i am looking for some good starting point for learning flex .
Flex :: Force Asdoc Run In English?
Apr 4, 2010My 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 RepliesFlex :: Possible To Include Example Mxml In ASDoc?
Mar 25, 2011Is it possible with ASDoc to include example MXML code in your comment?[code]
View 2 RepliesFlex :: Add XML To Asdoc Function Comments In It?
Mar 30, 2011How 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 RepliesFlex :: Add AsDoc Comments To A Component?
Aug 3, 2011I 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 RepliesFlex :: Compile A SWC File With Mulitple Namespaces?
Oct 5, 2009I'm trying to compile an SWC file from a list of given ActionScript classes. I'm using the compc compiler. The problem is that there are so many classes grouped into multiple namespaces that I am finding it very tedious to specify each individual class to be included in the SWC. Is there any easier way of doing this like just simply specifying a root directory of these classes? At the moment I have something like this:
[Code]....
ActionScript :: Flex - Interfaces With Custom Namespaces?
Sep 16, 2010Is there any way to get interface to play along with custom namespace? Example follows.
IHeaderRenderer.as:
public interface IHeaderRenderer{
function set header(value:IHeader):void;
function get header():IHeader;
}
[Code]...
Sorry for all the blabbing. Any cunning ideas how this kind of situation could be handled?
Flex :: Documenting Private Members With ASDoc
Dec 10, 2009Can ASDoc be set to document private members ala JavaDoc?
View 1 RepliesFlex :: Asdoc - Add A Comment To Some Elements In A Document?
Nov 21, 2010I 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..
Actionscript :: Access The 'mx' Or 'fl' Namespaces In A Flex Builder Project?
Apr 11, 2009How do i access the 'mx' or 'fl' namespaces in a Flex Builder Actionscript Project? Do I need to include a certain .swc file?
View 2 RepliesActionscript :: Flex - Cannot Get The Comments To Show In File When Running Asdoc
Jul 28, 2009cannot get the comments to show in actionscript file when running asdoc.. is this a known bug?
[Bindable]
/** test comment */
public var currentSearchTextValue:String;
does not show anything in the generated documentation.
AS3 :: Flex Documentation Of The Lesser Know Properties
Sep 17, 2009Over the past three weeks, I have lost at least 120 man hours because of some lesser known functionality in ActionScript 3. One of the problems was that, with Internet Explorer, if there are too many messages sent through LocalConnections, it will slow the messages sent through, but in the standalone player and in Firefox, this threshold is significantly higher. Another was that the static values of a class are instantiated even if the member itself is not being used:[code]Since FooClass had a static reference to a Singleton, that Singleton was instantiated so when I loaded a Module which used that Singleton, it would bind to values in an unpredictable way.Additional cases where things behave in an unexpected way:
So here's the question (and I'm sorry for omitting this in the original post), is there any consolidated documentation for this type of behavior anywhere? Is there any (even non-Adobe) documentation on these issues (websites, forums, books, ANYTHING)? I know that these things are definitely easy enough TO document, but has anyone done so?
Flex :: Asdoc Throwing Errors For MXML Component That Includes A Separate .as File?
Jul 27, 2010I have an MXML component that includes a .as file with
<fx:Script source="myfile.as" />
Running asdoc throws a whole bunch of errors like
"Error: The private attribute may be used only on class property definitions."
"Error: The public attribute can only be used inside a package."
Solution 1 is to move the AS code into the MXML file. Kind of defeats the objective of using external .as files for MXML components in the first place, so really a last resort option. Code inside a mxml file is messy (I really don't want logic mixed in with mxml), and would also require using the < !--- ---> asdoc syntax.
Solution 2 is to have the MXML component inherit from a normal class file. That would mean no private members in the base class, only internal (meaning a separate package for the component to be safe) or protected. This would make things tedious to say the least.
Are there any other work-arounds or possibly a beta/nightly version of asdoc that fixes the problem? I am using the Flex 4.1.0.16076 SDK, the "latest production quality release".
Update:Just tried using asdoc from the svn trunk, (4.5.0 rev. 16942) and the problem persists.
Actionscript 3 :: Styles That Are Not Found In Flex Documentation?
Jan 9, 2010today I wanted to change the border color of TextInput when user has a focus on it. I could not find any style that would allow me to change thatlittle bit of Google searching and I found answer to be themeColor.Why is it that there are some styles that work and which are not even mentioned in the Flex documentation? (and how can one find out about em, except doing some web searching?)
View 2 RepliesFlex :: Programmatically Get Documentation Comments From A Class , Method / Property?
Dec 11, 2010I know that I can get info about constants, methods, etc of a class by using flash.utils.describeType. But I want to know if I can retrieve the asdoc comments of a class member.
I suspect, documentation is removed when classes are compiled into SWF so it might be impossible to get comments during run-time.
Flex :: Packages Cannot Be Nested
Aug 31, 2010Its giving error on importing mx.resource.resourcebundle that packages cannot be nested[code]...
View 2 RepliesFlex :: Cannot Import Mx Packages
Dec 6, 2010In the Below action script file there is an error saying cannot import mx.controls.Label, I am compiling this through command line on,linux and the environment variable path is set where flex is installed ,how to resolve this
package {
import mx.controls.Label;
public class Test
[Code]....
Flex :: Blaze DS 4 Libs Missing Mx.* Packages?
Mar 29, 2012I just set up my environment (Flex 4.6 SDK, Blaze DS 4.01) and I'm wondering where the needed mx.* packages might be found, since I want to import classes, such as mx.messages.Producer / Consumer, in my non-MXML-Project and instanciate them programmatically. Blaze DS API ref says, they are part of the Blaze-WAR but I just can't find them.
View 1 RepliesFlex :: Error - "Packages Cannot Be Nested"
Mar 21, 2010I cant call a class using: "<fx:Script source:"myClass"/> For some reason, no matter what I do, the error is always the same.
"Packages cannot be nested".
Actionscript 3 :: Namespaces In Nested Xml Elements?
Dec 30, 2010I have seen afew answers to the problem i am having now but mine is that of a nested one.
I have an xml looking like this:
>
<em>
<type xmlns="http://www.sitcom-project.org/sitcom" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
[Code]....
now, how do i access the element of the implemented_with node?
ofc i could access the xmlList this way:
namespace ns = www.sitcom-project.org/sitcom;
type.ns::model;
but now, how do i access the implemented_with node in the model xmlList? i tried type.ns::model.implemented_with, but didn't work.
Actionscript 3.0 :: Store XML Namespaces In An Array?
Nov 29, 2011I'd like to know if it's possible to store namespaces in an array?Imagine i had infinite namespaces and i'd use "for" to store them automatically, what would i need? i don't think an array would save namespaces as they are.
View 2 RepliesActionScript 3.0 :: XML, Forcing Attributes To Have Namespaces?
Aug 6, 2009I'm writing some actionscript to provide a flash frontend to an MS Excel spreadsheet. The idea is that the user will be able to press buttons in a flash application, and that will enter data into the spreadsheet (which will be read and written as XML).
The XML of an MS Excel document looks like this:
Code:
<Workbook xmlns="urn:schemas-microsoft-com:office:spreadsheet"
xmlns:o="urn:schemas-microsoft-com:office:office"
xmlns:x="urn:schemas-microsoft-com:office:excel"
[Code]....