Mac OS X | Web & Software Development | HTML / Text Editors | VisDoc

VisDoc - 1.1

Create beautiful documentation from ActionScript 2.0 classes

(File Size: 8.2M)

VisDoc generates html documentation from ActionScript 2.0 class files

VisDoc integrates a smart processor to parse class files - you don't need to prepare or rewrite your classes. Even if you don't use doc comments, you can generate handy class documentation.
Class relations mean everything. VisDoc links superclasses and their methods to give a quick overview how classes are connected.
Flexibility is built in: documentation pages are formatted with editable templates (XSL and CSS). Just customize to have your own layout and style.
Changed some classes? Start up the application and hit the Process button - VisDoc remembers all your settings from the last time.

Features

Parses methods, properties, class type, superclasses, interfaces
Parses "get" and "set" methods as property variables; recognizes cases when get and set use different variable types
Parses Javadoc-style comments, with additional tags
Links superclasses and interfaces
Links inherited methods and properties from all superclasses
Processes multiple documents, multiple folders
Resolves included scripts, recursively
Recognizes duplicate files (duplicate class paths) - only uses the newest
No additional markup needed: @class, @method and @property tags are not required
Support for html formatted text inside doc comments
Clean designed layout of documentation
... with scalable font sizes
... fully customizable, based on XSL
... skinnable with CSS
... default output is XHTML strict, W3C validated
XSL and CSS are editable within the app
Optionally generate index page (frameset) with Table of Contents
... set custom index page title
Optionally add prefix to files
Optionally save as xml
Adds modification date class file
Adds creation date documentation

Distinguishes class/instance properties and class/instance methods. This separation is also used by Colin Moock in the appendix of Essential ActionScript 2.0. This is a user option and can be set off
the documentation then just lists Properties and Methods.
Added option to preserve linebreaks (when not selected, linebreaks and stars are ignored and documenation text flows as wide as possible).
It is no longer necessary in doc comments to start each line with a star
this is equivalent to Javadoc version 1.4.
Spaces in code examples that precede tabs are stripped.
Code examples that start with code and end with pre are converted to code/code.
Code examples that start with pre and end with code are converted to pre/pre.
Code examples that span multiple lines and use code/code are converted to pre.
Minor change to css to give pre blocks a top and bottom margins of 1em.
XML in code examples is now preserved (these do need to be surrounded by code/code).
The Table of Contents now shows an indication which classes are interfaces.
Interface update to have Settings on a separate screen.

Bug fixes
Fixed a bug where a single comment double slash as the last line of a method would mess up parsing.
Stars in code examples (for instance the multiplication sign) are no longer omitted from the doc.
Square brackets inside a code example are no longer omitted.
The Javascript file doc.js is no longer imported when "generate TOC and index page" is not selected.
The index title field is now updated immediately, so when entering a new name using the Tab key or deselecting is no longer necessary.
Interfaces are now properly linked when they are referenced without explicit class import.
The field tags @class and @method are now hidden from the documentation instead of showing the field tag plus comment.

This product is designed to run on the following operating systems:

	XSL editor
Settings