VisDoc generates html documentation from ActionScript 2.0, 3.0 and Java 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 with a Table of Contents.
- Class relations mean everything. VisDoc links interfaces, superclasses and their methods and properties 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. You can also save these settings in a project file, so you can use multiple projects without changing settings inbetween.
- For even more speed, update only modified or added files. VisDoc detects which files have been updated since the last run, and can process only those.
Documentation
Writing doc comments General introduction to Javadoc, and a practical guide how to write Javadoc comments for VisDoc.Features
- Universal Binary
- Parses methods, properties, class type, superclasses, interfaces
- Groups Class methods, Instance methods, Event handlers, Class properties, Constants and Instance properties
- Optionally lists private members
- Creates overview pages of classes, methods, properties, constants and deprecated members.
- ActionScript 2.0: Parses "get" and "set" methods as property variables; recognizes cases when get and set use different variable types get/set example
-
Parses Javadoc-style comments, with additional tags tags example
See also overview of supported tags - Links superclasses and interfaces Interface examples
- Links inherited methods and properties from all superclasses MediaController example
- Links classes in member definitions (parameters and return types)
- Inherits comments from superclasses inheritDoc example
- Lists component metadata metadata example
- Processes multiple documents, multiple folders, recursively
- 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 html example
- You can use leading asterisks in comments or leave them out and save typing.
- White space in code examples is preserved; example XML text is preserved Input variations example
- Cleanly designed default 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
- Full code colorizing support
- Optionally generate index page (frameset) with Table of Contents
- ... set custom index page title index/TOC example
- Adds a customizable main page
- Optionally save as xml
- Shows modification date of the class file
- Shows creation date of the documentation file
- Add your own copyright to the pages
- Save and load project files
- Update added and modified files only - file modifications are detected automatically
- View parsing results in a Log window, to get notified of invalid files or broken @see and @link references. Save log reports to a file. See example log file (RTF format).
- Immediately view output in browser
- Edit your custom CSS and XSL styles in the application
- Command-line interface (launches VisDoc UI app with parameters)
Example documentation
- Example class: Macromedia's mx.controls.MediaController class, and the processed documentation file
- Example class: Macromedia's mx.controls.CalendarLayout class, and the processed documentation file
- All Macromedia Flash classes - this also illustrates the generated frameset and Table of Contents page.
Screenshots
|
|
| Application window with log drawer | Application window: Settings |
Supported tags
VisDoc supports Javadoc tags, and some new tags that are commonly used or otherwise useful, such as @exclude. See the complete list below.
Javadoc is a commonly used tool for generating Java class documentation. The Javadoc format has become a code documenting standard.More information about Javadoc: see the Javadoc Tool Home Page and How to Write Doc Comments for the Javadoc Tool.
| Implemented Javadoc tags | |
|---|---|
| @author | |
| {@code} | |
| @deprecated | |
| @exception | |
| {@inheritDoc} | |
| {@link} | |
| {@linkplain} | Identical to @link as all links are rendered as plain text (no code font). |
| {@literal} | |
| @param | |
| @return | |
| @see | |
| @since | |
| @throws | |
| @version | |
| Javadoc tags that are not implemented | |
| {@docRoot} | Not implemented |
| @serial | |
| @serialData | |
| @serialField | |
| {@value} | Not implemented |
| FlashDoc tags | |
| @class | Not implemented: classes are detected automatically |
| @method | Not implemented: methods are detected automatically |
| @private | Explicitly marks property or method as private |
| @helpid | Not implemented: not useful for documentation |
| @tiptext | Not implemented |
| Implemented tags not in Javadoc spec, but commonly used | |
| @description | Explicit field name for the description - normally you don't have to specify the description text |
| @example | Code example how to use the class or method. Part of the Javadoc proposed tags. |
| @returns | Synonym for @return |
| @usage | Synonym for @use |
| @use | Code example how to use the class or method |
| Implemented useful tags | |
| @exclude | Excludes (hides) a property, method or class from the documentation. Part of the Javadoc proposed tags. |
| @history | List of changes |
| @implementationNote | Point of attention about the implementation, targeted to class developers |
| @sends | To document messages that are broadcasted to listeners |
| @todo | Part of the Javadoc proposed tags |
| @usageNote | Point of attention when using a class or class member, targeted to class users |
| {@img} | Include images in your documentation |
Pricing
A VisDoc single user license is available for USD 40.00. A company license is available for USD 160.00. You can purchase an individual license from within the app, or by visiting the Kagi store. Company licenses are available through Kagi.
With a license you are entitled to dot upgrades (feature releases) and of course dot dot upgrades (bug fixes).
Download
Try VisDoc before you buy. In trial mode, the application is fully functional, but will reverse one out of four documentation files.
| VisDoc 2.2 for Mac OS X 10.5 (G4 and Mac Intel) | 9 MB |
| VisDoc 2.2 for Mac OS X 10.4 (G4) | 9 MB |
This release's changes
| 2.2 | 04 Sep 2009 |
|