Actionscript 3 :: Writing Documentation - Creating Online Documentation?
Jun 17, 2011
I'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).
View 1 Replies
Similar Posts:
Sep 10, 2011
What is your approach to writing documentation explaining the options and use of XML files for a project ?Do you write commented instructions directly in the XML file ?Do you create a different text file in which you write instructions ?Do you explain the use of blocks of XML or do you detail each element and it's function ?I am looking for some guidelines on how to write the documentation for large XML files that control the settings and content of projects.
View 1 Replies
Nov 18, 2010
is there no official documentation / guide published somewhere on how to create components for Flash CS5?
View 1 Replies
Oct 18, 2010
I am trying to put a Flash ActiveX control into a Windows Form but I am running into a problem: a lack of documentation. The best I have found is a site called "F-IN-BOX" that has some documentation but much of the API is still a black box. For example, some property will take an integer or a string and provide no clue about what it wants. Another exanple is the FlashVersion() function that inexplicably returns 655361 on version 10.
Incidentally I'm having the same problem with Apple's Quicktime OCX. I've searched both sites and Google and I'm starting to wonder if either of these companies provide documentation for any of their products. Does anybody know where I can find documentation for either of them, even if it's the unofficial variety?
View 2 Replies
Aug 8, 2011
I know when I used to program java that their was a way to produce documentation. You had to comment a certain way and then do a certain procedure.
How do you make the documentation in AS3, Flash?
View 4 Replies
Dec 20, 2010
It's been a while since I've done any AS3 dev. but now I'm working with CS5. I remember back in the good ol' days of CS3, You opened it up and there was a whole list of classes and it allowed you to drill down into each and see great examples and full documentation. Now, whenever I click on help it brings up this awkward and overly complex AIR interface. I don't like this! Is there anything like the old interface?
View 3 Replies
Nov 12, 2009
I've been having troubles finding documentation on how to use these 2 files:
allowedHTMLdomains.txt
allowedSWFdomains.txt
point me to some documentation? I'd need some background about how they work.
View 2 Replies
Feb 7, 2010
[code]1. Rewrite the class and put it in a package statement and save it as Example.as
2. Create an Fla file and place in it an import statement and the code where the instance is created.If the code can run as is, how do you do that by merely pasting all the code into a FLA file.
View 3 Replies
Jul 1, 2010
Does anyone have the Macromedia MX Documentation Updater or the updated help files or even a PDF? My help doesn't work properly in the browser. I can get to the Macromedia MX Documentation Updater page on the adobe site, but I can't get past the register and download page.
View 1 Replies
Feb 25, 2011
I am trying to embed an f4v file into Flash CS5, however the program won't accept the file I've tried renaming the extension and removing the audio stream. The only thing that seems to work is if its a TRUE flv file using VP6 and with a .flv extension.The documentation here regarding embedding flv/f4v mentions the ability to embed either file formats:I have found no positive results on google and there doesn't seem to be a Flash Jira for bug tracking.
View 2 Replies
Sep 17, 2009
Over 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?
View 3 Replies
Mar 16, 2010
Does 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 Replies
Oct 7, 2010
Is it possible to write/install your own documentation for self-created classes along with Adobe's documentation in Adobe?
View 3 Replies
Feb 10, 2011
how does one enable the actionscript documentation to appear properly in Eclipse? For example, if you hover over addChild, the ASDoc view brings up the class hierarchy with [code] but does not give any of the details, descriptive text, parameters, etc. If I write my own documentation using the /** */ format, it does appear in there.
View 1 Replies
Nov 1, 2011
I have been working with Flixel in FlashDevelop for quite some time, and I recently updated my Flixel library to the latest version. Some things have changed names or have been moved or had their inputs changed. For some reason, FlashDevelop is still showing me the documentation from the old version of Flixel as I type things in, so I keep trying to use variable and functions etc that no longer exist.
View 1 Replies
Feb 4, 2009
I'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 Replies
Nov 1, 2007
The Help file for Flash 8 says regarding MovieClipLoader.unloadClip()
Originally Posted by flash docs
Removes a movie clip that was loaded by using MovieClipLoader.loadClip(). If you issue this command while a movie is loading, MovieClipLoader.onLoadError is invoked.so i assumed that i could use unloadClip to cancel a download...neither of these things seem to be true - anything in the function associated with the MovieClipLoader.onLoadProgress event continues to execute despite the unloadClip being called.is there a way to halt the MovieClipLoader from loading?
View 10 Replies
Oct 26, 2009
There is broken url in example for MovieClipLoader class documentation. I saw a link [URL] for few times for example [URL]
View 1 Replies
Nov 30, 2009
I am trying the basic XML parsing code from the adobe documentation.. I tried it with several RSS feeds I plan to use, many of large websites.. one worked, the others returned status -10, status: -10 (An end-tag was encountered without a matching start-tag.) the thing is, these are big sites, there is no way all of their feeds are malformed... plus, I checked briefly the XML structure, and checked it with an XML syntax checker (Notepad++) and it came out correct.. so why is flash treating these as malformed ? how can I solve it ? [URL] this doesn't work, and other don't as well from other sites, some other links do work.
I made some progress, I found that loading this rss url, via a browser gets me the right content, but when I try it in Orbit download manager, I only get six bytes! which are </rss> maybe this is what flash sees as well ? what could be the reason for me getting only partial content ?
[Code]...
View 1 Replies
Dec 14, 2009
I am trying to make a full Flash site SEO'd and have come across a problem which it seems the swfaddress optimizer javascript can fix, but i can't find out how to configure it.
View 2 Replies
Jan 9, 2010
today 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 Replies
Apr 4, 2010
I am trying to host a flash object inside an CAxWindow, I have managed to insert a shockwaveflash (SWF) and its working fine. I am trying to find all available API's that are available in the flash ocx. I am unable to find any documentation for the functions in the IShockwaveFlash interface.I know that Adobe doesn't have a documentation for using flash in VC++ but I was wondering if anyone can point me to a place where I can find an UNOFFICIAL documentation for flash.ocx or code samples as the only API that I could find and I'm currently using is "PutMovie".
View 2 Replies
Apr 20, 2011
Still getting use to Flash Builder.
i'm writing pure ActionScript, without MXML, to create AIR applications.
when i try to reference the documentation by Command + Clicking on code (in this case i Command + Clicked on "Sprite") i receive the following error[code]...
View 2 Replies
Jun 9, 2011
The docs I can find for flash.globalization.DateTimeFormatter are here In those docs, the examples show the use of an important method called setDateTimeStyles(). However, there is no such documented method! Same goes for format().
I feel I'm missing something or am looking at dated/incomplete material (or am a complete idiot). Where is the correct/best documentation?
PS: I'm finding I have this general problem (missing/incomplete docs) quite frequently and this question could actually be "Where is the 'correct' flex/actionscript documentation? Or is it just bad?", but I'll be very specific (and non-inflammatory) to try and improve the odds of a clean answer...
View 2 Replies
Sep 2, 2011
basically I want to use GET method when I upload an image to a server. the docs ( file:///C:/Program%20Files/adobe/Ado...ref/index.html ) say: Quote: Flash Player uploads files by using the HTTP POST method but just 2 paragraphs later, Quote: You can send POST or GET parameters to the server with the upload() method
View 9 Replies
May 9, 2010
Are there any good tutorials out there that go over the AS event model in detail.I am trying to figure out things such as what are the 'default behaviors' attached to different events.Supposedly the the default behavior for a text event is to type in a TextField (makes sense). Also that behavior is supposedly canelable.However I can not find listed in the AS documentation.Maybe I am just not looking in the correct place.
One thing I really liked about java was the documentation.Everything about the class structure was laid out very elegantly and documented.I could tell exactly what events a class listened to or broadcast a paticular event, and how they responded.Also I i could tell which section of the code was responsible for drawing / redrawing graphics.But maybe I have not spent enough time with AS.
View 2 Replies
Jan 14, 2010
How to embed a Flash application into trac Wiki
View 2 Replies
Jul 5, 2010
does anyone know how/where to download actionscript 3 flash platform full documentation in packed HTML files. What I want is to have a local copy of the following doc: [URL] We are currently using a local copy of FLASH4 actionscript docs, which is quite out-of-date.
View 3 Replies
May 18, 2009
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 Replies
Apr 5, 2004
anybody using their tween playground ? i can't get the **** thing to work and seeing how it lacks any kind of documention (short of the info panel)i can for startes i have to set the linkage right so it exports on the first frame buuuut that's where it pretty much stops... o and that the as dir has to be in the same folder as the flash file (or properly linked in the code_init)
View 2 Replies
