ActionScript 3 (AS3) API Reference
Scripts developed by Gene Pavlovsky [email protected]
Description
ActionScript 3 (AS3) API Reference
from Adobe, suitable for offline access using FlashDevelop or a web browser.
Provides scripts for downloading and optimizing the latest reference, enabling offline usage, improving rendering speed and reducing clutter.
Contains TocGen
tool for generating the help TOC file suitable for use with FlashDevelop via OpenTheDoc plug-in.
Downloads
Latest version: July 2017 (Flash 25.0, AIR 25.0)
- Base API Reference 7z - Base AS3 API Reference, excluding Flex (recommended for AIR developers).
- Flex API Reference 7z - Flex API Reference (recommended as add-on to base for AIR+occasional Flex developers).
- Base+Flex API Reference 7z - Base AS3 API and Flex API Reference (recommended for Flex developers).
- Full API Reference 7z - Entire AS3 API Reference (recommended for Enterprise developers).
- Complete ZIP of the repository
Scripts usage
The scripts are written in bash
and awk
and should be able to run on UNIX
or Cygwin
.
- Review
config.sh
. Any custom settings can be added toconfig.local.sh
. - Run
scripts/fetch_src.sh
to download the AS3 API Reference from Adobe tosrc/
using wget. This will take a long time. - (optional) Just in case, create an archive of
src/
. - Run
scripts/clean_src.sh
to move unwanted files fromsrc/
totrash/
. - Run
scripts/make_doc.sh
to optimize the html files fromsrc/
, outputting intodoc/
. The optimizing itself is done byscripts/make_doc.awk
. This will take a long time. - (optional) Run
scripts/verify_doc.sh
to make sure that every file insrc/
has a matching file indoc/
. This will take a while. - Run
bin/TocGen.exe
, fill in the full path to thedoc/
directory, and clickGenerate
. This will take a while. - Run
scripts/fix_toc.sh
to fix a problem with the links in the TOC file. If following the next step, this script will be ran automatically. - (optional) Edit
config.sh
, setprune_packages
to the list of packages you don't want, then runscripts/prune_doc.sh
to remove them and update the TOC file. - Copy
doc/
wherever you want and use them with FlashDevelop via OpenTheDoc plug-in or a web browser.