About
This is a JavaDoc-a-like for ActionScript
2.0.
It began it because there don't seem to be any complete, free
(GPL or similar),
API
documentation tools, as of November 2004.
The scripts are implemented in
Ruby,
and work under Windows, Mac OSX, and Linux. An exe is provided for windows
users who don't want to install Ruby.
Status
If you already know JavaDoc, lots of stuff will work as
expected.
See the specifications of
features that
could be implemented in future releases, and the
bugs in the
current version.
Examples
- org.aswing.*
- Documentation for the AsWing framework, version alpha-2.
- com.as2lib.*
- Documentation for As2lib framework, version 0.9.3.
- org.omus.*
- Documentation for Oregano Multiuser Server client, version 1.2.0-beta5.
Documentation
Read the as2api documentation
online (a PDF version is included in the downloads below).
Downloads
Subscribe to release announcements
Current
0.4 2006-02-05
as2api-0.4.tar.gz
as2api-allinone-w32-0.4.zip
as2api-allinone-osx-0.4.sit
Changes since 0.3:
- Added simple 'Quicknav' DHTML search box
- Added tooltips (XHTML titles) to most links
- Document instances where a method is overriding a method from
a superclass
- For undocumented methods, try copying documentation from the
overridden/specifying method in the superclass/interface
- Type summary descriptions now appear on package index
pages
- Optimisations, for a modest increase in parsing speed
- Additional
--sources option cases
syntax-highlighted source code to be included with the
documentation - Small improvements to error messages
- Fix bugs with code specified in relative paths (those starting
with
'..') probably being ignored - Rewrote doc-comment parsing again
- Syntax highlighting in
{@code} tags - Now tries to avoid generating empty sections for Fields /
Methods
- Lots of XHTML fixage
- Improved documentation
- New syntax for documenting variable-length argument
lists
- Support
@exception as a synonym for
@throws - Allow for multiple fields in a class, defined in a single
var statement - Much refactoring of as2api internal implementation
details
- Standard stylesheet looks closer to JavaDoc (eeek!)
- Super-sekret stuff!
Previous
0.3 2005-06-28
as2api-0.3.tar.gz
as2api-allinone-w32-0.3.zip
as2api-allinone-osx-0.3.sit
Changes since 0.2:
- Threw away windows GUI again (may return in some later
release)
- Vastly improved command-line interface
- Package documentation may include class/interface inheritance
diagrams if the
--draw-diagrams option is
used - Documentation now includes an alphabetical index of types,
members and packages
- Private class members are now excluded from generated
docs
- Implemented
{@link ...} tag handling - The
@see ... tag will now generate links to
types/members, per JavaDoc - Implemented
{@code ...} tag handling - Added 'Specified By' section to method description, showing
which interface defines the method
- Types that aren't being documented may still be processed.
e.g. you can now see the stuff you inherit from
MovieClip without having to generate docs for
MovieClip itself (as long as the MM classes are in
the classpath) - The encoding of input files may be specified
- It is no longer necessary to copy the CSS into the output
directory by hand
- It's possible to supply some text to appear in HTML page
titles
- Too many XHTML compliance bugfixes to list
- HTML in doc-comments will now stay as HTML in output, without
< being encoded as <,
etc.
0.2 2004-12-07
as2api-allinone-w32-0.2.zip
as2api-0.2.tar.gz
Changes since 0.1:
- GUI for Windows
- Frameset navigation pages now generated
- Method and field indexes contain links to methods and fields
inherited from super-types
- Support
get and set
implicit property access functions - Notice constructor functions as such, and present differently
in documenation
- Sort lists alphabetically, in various spots
- Tiny Ruby 1.6 compatability fix
- Hack to derive package-name from source path, when no package
is specified in the source file
- Don't give error for
intrinsic
keyword - Don't treat
is as a keyword - Ignore [attributes] preceeding types and type-members, rather
than producing a parse error
- Generate documentation for fields as well as methods
- Ignore
#import keyword (allow parsing to
continue, rather than cause a parse error) - Fix known causes of parse errors due to missing
semicolons
0.1 2004-11-21
as2api-allinone-w32-0.1.zip
as2api-0.1.tar.gz
- Output looks vaguely like JavaDoc if you squint
Code
To obtain a copy of the latest code, use the
Subversion
repository at the URL:
http://svn.badgers-in-foil.co.uk/as2api/trunk/as2api/
Contact
Direct all comments to the as2api development mailing
list as2api-dev
Bugs
Please report bugs to the above mailing list, or use the project's
support
request page (registration required).
Related Software
Other ActionScript 2 API documentation generators:
Directory Categories:
The Daddy: