Modified as2api Source Code

April 1, 2009 by kbunch

Development

If you have ventured into our Media Framework documentation, you will notice that we have matching docs generated for ActionScript 2 and ActionScript 3. Thanks to Adobe, we have an official documentation tool (ASDoc included in the Flex SDK) for ActionScript 3 chunked full of features. For ActionScript 2 we had to rely on the community and ended up using the open source as2api project. Unfortunately as2api lacked some of the features we used from ASDoc, so we modified the source to enable it to do some of the things we wanted.

Modifications

Expose/hide private members

as2api hides all private members by default. We wanted the option to treat private members like they were protected members and document them if we wanted. Therefore we made exposing private members optional, defaulting to exposing them.
To usage for this option:
--hide-private

Hide members with @private tag

A common tag in ASDoc is @private which allows you to selectively hide certain members from being exposed/documented. This helps keep your documentation from appearing really cluttered, which was our case in exposing all private members. This tag can now be used in your documentation preceding a member declaration to hide it from the docs.

Document Event metatags

Obviously ActionScript 2 didn't have a formal event framework. However, we created one that mimics ActionScript 3 and wanted it documented in the same fashion. We didn't put all the same hooks in as ASDoc, but we got the basic event listing and class references.
To tag an event to be documented place the metatag prior to the event like ASDocs.

[Event(name="bufferTimeStarted", type="com.dreamsocket.events.BufferTimeEvent")]

It felt only right to contribute those changes back the community, so we are posting the source and binary here for anyone wanting to take advantage of our changes.

Download

Grab the source and binary.

The caveat here is that Chad had never seen Ruby prior to this project, so he just hacked the source. It may not be the prettiest code, but it works. Who knows how many people are still maintaining ActionScript 2 libraries, but hopefully this will come in handy to someone. Happy code documenting :).

Comments

Thanks to Adobe, we have an official documentation tool (ASDoc included in the Flex SDK) for ActionScript 3 chunked full of features. For ActionScript 2 we had to rely on the community and ended up using the open auto insurance comparison source as2api project. Unfortunately as2api lacked some of the features we used from ASDoc, so we modified the source to enable it to do some of the things we wanted.

December 11, 2009 - 3:47am

Joined: 12/11/2009

Member: weliiam

as2api is a JavaDoc-like API documention tool for ActionScript 2.0, released under the terms of the GPL.

The scripts are implemented in Ruby, and compiled command-line binaries are available for Windows and Mac OSX. 640-802 350-001 VCP-310 SY0-201

Main Features

*
Parses the actual ActionScript code, so you’ll have a reference for methods even if you didn’t comment them yet
*
XHTML output, which can be styled with CSS
*
Can include the syntax-highlighted source code of each .as file alongside the API reference, if you wish
*
Uses JavaDoc comment syntax
*
Can draw per-package type inheritance diagrams if you install GraphViz
*
DHTML ‘search’ box in the navigation lets you find classes and methods by typing their names

December 24, 2009 - 5:13am

Joined: 12/24/2009

Member: ping123

That’s indisputable that the masters writing services could compose the superb quality customized essay for students which don’t operate the writing technique. That can be the best way out for them, I do think!

January 14, 2010 - 2:39am

Joined: 01/14/2010

Member: Mv28Sophie

tiffany jewelry
Choose, buy and shop for on sale tiffany jewelry including Tiffany & Co Silver Necklace, Pendants, Bangles, Bracelets, Earrings, Rings and Accessories.
tiffany co
Tiffany Jewellery offering bangle Jewellery, bracelet jewelry, eardrop jewelry, necklace jewelry, ring jewelry, finger ring jewelry and earring jewelry
tiffany
tiffany and co
links of london
links london
Tiffany Style Silver Jewelry: Rings, Earrings, Necklaces, Bracelets and more Tiffany Jewellery at low prices.

January 25, 2010 - 12:29am

Joined: 01/25/2010

Member: lihaoxj16

Prom Dresses 2010 including designer Jovani prom dresses, cheap and affordable prom dresses,
sexy prom dress, wedding, bridesmaid and mother of the bride
Wedding Gowns
Evening Gowns
Formal Gowns
Prom Gowns
Shop prom dresses, formal dresses, prom shoes, 2010 designer prom gowns at dres4sale.
for cocktail dresses, dresses for prom, homecoming dresses, and evening dresses. Cheap prom dresses or couture designer evening gowns for your next formal.
prom dresses
christian louboutin
Evening Dresses. Women's Formal & Special Occasion Dresses ... Welcome to Cheap Evening Dresses for Sale! ... Buy Cheap Evening Dresses Sales & Accessories
evening dresses

January 30, 2010 - 10:14pm

Joined: 01/30/2010

Member: see

We are professional brand shoes, Gucci Handbags, Gucci Shoes and satisfied customers always come first. We have huge quantity of Gucci Purses, Gucci Belts, Gucci Loafers and Gucci Sneakers for sale! You can find the exact gucci whether Gucci Men's Shoes or Gucci Women's Shoes you want at a price that's right for you.Moreover,We provide the best service and fast shipping to customers all over the world.
High distinctive and exquisite quality Gucci Products like Gucci Handbags, Gucci Shoes and satisfied customers always come first. We have huge quantity of Gucci Purses, Gucci Belts, Gucci Loafers and Gucci Sneakers for sale! You can find the exact gucci whether Gucci Men's Shoes or Gucci Women's Shoes you want at a price that's right for you.Moreover,We are professional brand shoes.

February 1, 2010 - 4:35am

Joined: 02/01/2010

Member: uhey

February 1, 2010 - 4:37am

Joined: 02/01/2010

Member: uhey

I like the side of the article, and very like your blog, to write well and hope to continue your efforts, we can see more of your articles.Christian Louboutin shoes. Recommend you to take a look at it, is now being discounted, Louboutin Fall-Winter Collection in hot! Fashionable Christian Louboutin Keeps with you at any time. Anybody can tell me where i can buy the best and the cheapest shoes ，I have to tell him that is louboutin shoes ,it will be your right choice.

February 6, 2010 - 1:57am

Joined: 02/05/2010

Member: kakijing

In 1988, Limited company bought the United States, if influence an, (Abercrombie Fitch general), can be a small aristocracy. Cheap Abercrombie and Fitch Polos Cheap Abercrombie and Fitch Polos discount Abercrombie and Fitch Polos discount Abercrombie and Fitch Polos Abercrombie and Fitch Polos sale Abercrombie and Fitch Polos sale buy Abercrombie and Fitch Polos buy Abercrombie and Fitch Polos Cheap Abercrombie Fitch Polos Cheap Abercrombie Fitch Polos discount Abercrombie Fitch Polos discount Abercrombie Fitch Polos Abercrombie Fitch Polos sale Abercrombie Fitch Polos sale buy Abercrombie Fitch Polos buy Abercrombie Fitch Polos Cheap Abercrombie Polos Cheap Abercrombie Polos discount Abercrombie Polos discount Abercrombie Polos Abercrombie Polos sale Abercrombie Polos sale buy Abercrombie Polos there are no open to add a new. In the ” Abercrombie and Fitch ” of poor crop sales department.