How 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 Repliescannot 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.
My 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 RepliesCan ASDoc be set to document private members ala JavaDoc?
View 1 RepliesI 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..
As 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 RepliesFlashBuilder's undocumented mm.cfg file has a lot of cool options as shown here and elsewhere. But what about commentsout there verify if comments are supported in FlashBuilder's mm.cfg file?If so what are the rules? For example:REM .bat style comment; .ini style comment# shell style commentines?
View 1 RepliesI'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 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.
I'm trying to use a custom Text component to show a series of comments. I got the original idea from:
[URL]
I've got the base case working but I am stuck with 2 problems I cant seem to figure out:
Since I am drawing around the text, the actual height of each bubble is greater than that of the Text field, as a result, the last bubble is always chopped off. I have tried explicitly overriding the height getter, and adding some padding, but I cant seem to get it right. You can see an example here: [URL] In my layout, I have 2 VBoxes (one nested inside the other). The first vbox shows a form where the user can enter a comment, and the second box has all the comments. In order to ensure that the scrollbars only show up on the second box, I set minHeight="0" on the nested VBox, but then for some reason, some comments' text is shifted to the right. You can see an example here (look at the first comment): [URL]
Rather than posting the code here, I've provided some links:
[URL]
I 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.
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 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 RepliesI'm running ASDoc to document my code. (The command line tool shipped with Flex that generates documentation of your code.)I'm running into a problem. I created a project targeting Flash Player 10 and the project compiles just fine in Eclipse, but when running ASDoc, one of the classes I use contains methods that are NOT available to flash players lower than Flash Player 10. Thus the ASDoc tool is generating an error, b/c it doesn't know I am targeting Flash Player 10.How do I tell ASDoc that I wish to target Flash Player 10?
View 1 RepliesI am trying to use AsDoc on the code of one of my projects in flash. Some of the classes that I use inside the code are "exported for actionscript" classes from my FLA file. Of course the AsDoc compiler complains that those classes are not defined anywhere. Does anyone know how to make it ignore these class types?
View 1 RepliesI am using ASDoc tool for action script3.0 using flash develop's document ation generator. I have also tried it using command line . I have included external swc library. The problem i am facing is..when i generate documentation than i will get following error
" Error: Type was not found or was not a compile-time constant: "...as far as i did some R&D , this is not a synatx error. I am guessing that ASDoc is not able to detect those classes oif SWC which i included in my project.
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?
Is it possible to use comments in Flash? I don't mean in actionscript using //, but somehow documenting how the app is setup.
View 1 RepliesI love looking through other people's codes and see how they style their comments, most people use a mix of * and ////, and of course it all depends on the language, but I have definitely seen some good ways to comment and some bad ways. A coded page can really come together with the right commenting structure and make it really easy to read for someone coming into a project without any knowledge.
View 3 RepliesI'm trying to run ASDoc on just one of my classes, but I keep getting the following:
ActionScript Code:
Error: Cannot find JRE.
Error: Cannot find Java 2 Runtime Environment.
I've read up on the issue and I tried setting up the JAVA_HOME environment variable to point to ..AdobeFlex Builder 3jre folder but it's not working at all. Is there a compatibility issue or is something else going wrong?
/edit: Nevermind, it just started working. I guess I had to exit out of command prompt before it took effect
You know them flash decompilers - can they read your comments you leave in your code?Also, is there anyway to remove the comments if they can -- and can you somehow remove all whitespace and compact it so the swf runs faster, better, and is a smaller file?
View 1 RepliesI'm creating a XML with AS3 and save it as file.The problem is, that i can't add this to the beginning of the XML:[code]The problem seems to be the Comments and the definition (<! and <? ).[code]
View 1 RepliesI'm having a bit of a hard time putting what I want into words, which is probably why programming it has got me a bit stumped.Basically what I want is a nagavatable guestbook where the names of the people who left comments is shown in a list, and clicking on the various names would display their comment in a dynamic text box. This whole thing started as an extention of the XML Guestbook using PHP tutorial.My idea, and the way I've been trying to go at this, is to have the names show as text (not buttons or a movie clip, if I can avoid it) in a text area with a scroll bar to allow for as many entries as possable. Clicking on a name would load the data within the <comment> tag into a dynamic text fieldHere's more or less what my XML file looks like
Code:
<guestbook>
<entry>
[code]....
if someone decompiles my code, do they see my comments?
View 1 RepliesI built my first flash site and I wanted to add the ability for visitors to add comments to videos on my site, similar to this site.
View 5 Replies