|
1.5.3
|
12 September 2005
|
- Added to preliminary support for running VisDoc from the command line, the option to run .visdoc files:
In Terminal, go to the folder where VisDoc resides.
- Type:
./VisDoc.app/Contents/MacOS/VisDoc followed by: -process and the full path of the visdoc project file.
For example:
./VisDoc.app/Contents/MacOS/VisDoc -process /Users/arthurclemens/Desktop/all_tags.visdoc
VisDoc will now launch, run the project file, and close itself.
|
|
1.5.2
|
10 September 2005
|
- Preliminary support for running VisDoc from the command line.
In Terminal, go to the folder where VisDoc resides.
- Type:
./VisDoc.app/Contents/MacOS/VisDoc followed by: -process and the files and folders (full paths) in quotes (separated by a space, as happens automatically when dragging these to the Terminal), followed by: -out and the output directory
For example:
-
./VisDoc.app/Contents/MacOS/VisDoc -process "/Users/arthurclemens/Desktop/code/" -out /Users/arthurclemens/Desktop/documentation/
- Fixes syntax coloring of ActionScript code
- Fixes a bug with links to overloaded members
|
|
1.5.1
|
5 July 2005
|
- Fixed a parsing bug with specific characters in comments.
- Should fix all issues with 10.3 systems earlier than 10.3.9.
|
|
1.5
|
3 July 2005
|
- Added the option to automatically start processing every x minutes (configurable).
- Added the option to include source code with the documentation.
- Updated class overview layout.
- Added referring links "Known subclasses", "Known subinterfaces", "Dispatched by" (the latter for events that are documented with
{@sends EventName}.
- Processing with the option "modified files only" on is now a lot faster: all processed data is now stored in the .visdoc project file, so when one modified file is being processed, only that file is parsed while the information from other classes is retrieved from the project file.
- Links to private members are now consistently gray (you can set another color in the stylesheet)
- The TOC left bar now highlights the currently displayed doc file.
- Added access keys for page navigation: use CTRL (on pc: ALT) plus the key to jump to the page part.
- Preliminary support for generation of Java documentation (beta level: bugs may appear here and there)
Bug fixes:
- It is now possible to have multiple vars on one line. For each variable a separated documentation entry is generated; see Properties documentation (properties x, y and z).
- Fixed:
/**< @exclude */ for properties now works.
- Fixed duplications in the "Events broadcast to listeners" class list.
- A number of fixes for inheriting doc comments:
- Now automatically inherits comments from interfaces.
- A @link tag now generates a link if the link points to the class the link is in.
- Automatically inherits comments with links in them.
- Corrected linking when "process modified files only" is chosen.
- Automatically generate links when these end with an anchor link.
- Fixed single line comments inside <code> tags (the second single-line-comment would disappear).
- Class descriptions that start with a code comment are no longer mangled.
- Fixed: after modifying the XSL or CSS in VisDoc, the 'dirty document' window button would not update.
- Unable to fix: somehow Safari stopped to automatically open the first link in the TOC when viewing on a local computer. When the files are on a web server Safari works as expected.
Added examples:
NEW Java examples:
|
|
1.4.5
|
24 April 2005
|
Bug fixes:
- Fixed a bug where a interface reference in some cases was pointing to a wrong class.
- Comments with the shorthand notation
/**< my text */ are displayed again.
- Relaxed the parsing of first sentence summaries so that links in the first line with an uppercase letter are no longer broken.
|
|
1.4.4
|
29 March 2005
|
- New syntax for @sends with event objects. You can use 2 formats:
- Format 1: @sends method-text # comment-text
- Format 2: @sends event-classname#type-name comment-text
- See the documentation for more information.
- Descriptions in constructors are now inherited from the superclass constructor (automatically, implicit, and explicit when using {@inheritDoc} in constructor comments).
Bug fixes:
- Fixed a bug that caused private static properties to be shown as public.
|
|
1.4.3
|
23 March 2005
|
- Initial values with property declarations are now listed. See CalendarLayout for output example.
Bug fixes:
- Methods that are called set or get are no longer automatically assumed to be a property getter or setter. See update of getter/setter example.
- Properties show their type again - this was missing in versions 1.4 to 1.4.2.
- Static properties show show the word "static" again - this was missing in versions 1.4 to 1.4.2.
- It is now possible to have url strings inside code comments without getting tags around them; automatic linking of url strings now only happens outside code text. See InputVariations for output example.
Added example:
|
|
1.4.2
|
20 March 2005
|
Bug fixes:
- Properties with no javadoc comment are listed again; in version 1.4 and 1.4.1 properties without javadoc comments where erroneously ignored.
- The summary line parsing is improved, so lines that end on a HTML block tag are rendered correctly (see documentation).
|
|
1.4.1
|
14 March 2005
|
- Classes are now linked in member definitions (parameters and return types).
- Support for {@code} tag.
- It is now possible to add links to @sends tag descriptions; the descriptions plus links are copied automatically to the class description.
Bug fixes:
- Fixed a bug that caused a @sends tags without comment to be rendered as 'null'.
- Fixed a bug that caused VisDoc in some cases not to find a superclass.
- Fixed a bug that caused VisDoc to crash in a rare situation.
|
|
1.4
|
6 March 2005
|
-
Added support for inheriting comments: explicitely when encountering the tag {@inheritDoc}, and implicitely following the Javadoc rules (see Sun's Javadoc reference on Automatic Copying of Method Comments).
-
Following this specification, VisDoc now automatically adds a link under "Overrides" when a method overrides a superclass method; and adds a link under "Specified by" when a method implements an interface method.
-
VisDoc now lists component metadata tags: Inspectable, InspectableList, Event, Bindable, ChangeEvent, Collection. The tags IconFile and RequiresDataBinding are ignored as these add no value when listed in documentation. More information about component metadata tags: Macromedia's livedoc page Adding Component Metadata.
-
Added highlight script (http://dorward.me.uk/software/frag/) so members linked from another class are easier to recognize.
-
Reformatted the TOC, both in the left bar and in the full page version; see for example this full page toc.
-
Added the option to add a comment to @sends tag.
Usage note
-
The comment is written after the method declaration, with a hash sign as separator:
@sends onLoadStart(name:String, this:Loader):Void # When the file starts loading
Bug fixes:
-
Fixed a bug that caused setter property methods to not list the property's type but instead the method's return type.
-
Fixed a bug where the application on opening sometimes would not automatically list the class files.
-
Fixed a bug where @link tags where not resolved if they occurred in a constructor or property description.
-
Fixed a bug where the link to the interface under the caption "Implements" was not resolved in all cases.
-
Fixed a html bug that caused the documentation page of a class that implemented an interface to not longer validate.
New examples:
|
|
1.3
|
19 November 2004
|
-
Settings can now be saved to and loaded from project files.
-
VisDoc now automatically detects if files are updated or added. You can optionally process updated or added files only.
-
Added a log window, to report about processed files, invalid and duplicate files, broken @see references, and about added, removed and updated files. The log can be saved to disk.
-
{@link} tag is now supported.
-
Added an "Open in browser" option.
-
Improved code colorizing: identifies keywords (like: if, return, throw), identifiers (like: _parent, MovieClip), properties (like: _x, _currentframe), numbers, comments and strings. All colors can be changes with CSS.
-
The @deprecated tag is now displayed according to the Javadoc specification: VisDoc moves the deprecated-text ahead of the main description, placing it in italics and preceding it with a bold warning: "Deprecated". A few small changes to CSS and XSL have been made to support this.
-
The @throws and @exception tags are now displayed according to the Javadoc specification, with a link to the referenced class.
-
Modified javascript to improve display speed when showing/hiding private members.
-
German localization.
-
interface improvements.
Bug fixes:
Added examples:
- Examples of the {@link} tag: class
and
doc
- Examples of the @throws tag: class
and
doc
Updated example:
|
|
1.2
|
15 September 2004
|
-
Italian localization.
-
List private members (optionally). When they are listed, you can toggle them off and on with a link.
-
Support for the @see tag (header See also), to link classes and methods. See How to Write Doc Comments for the Javadoc Tool for more information about @see.
-
Added support for as2lib's overload function, with the new @overload tag (header Overloading).
Usage note
- The notation for @overload is similar to that of @see. For example:
@overload #methodA
@overload #methodB
The parameters and return type of the overloaded methods are then added automatically.
-
Added support to for events that are sent or received:
-
Sent events:
With the new tag @sends, to list messages that are sent by a method (header Messages broadcast to listeners)
Example:
@sends onLoadStart(name:String, this:Loader):Void
No link is created, but all @sends tags from all methods are collected in the class description to give a quick overview of all messages that a listener can subscribe to.
-
Received events:
All methods that start with "on" or "allow" are (optionally) grouped under the header Event handlers. You can also enter other prefixes.
-
Added support for
/**< comment */ syntax for properties. This makes the layout of the code for properties much cleaner, as all comments can be listed to the right of the property declarations.
Example:
public var item:String; /**< Item to be printed. */
public var mc:MovieClip; /**< Reference to self. */
-
Option to add a copyright notice to documentation pages.
-
Automatically creates links from written out urls that start with http://
-
'CODE' and 'PRE' tags are converted to 'code' and 'pre' to make the documentation W3C compliant.
Interface updates:
-
You can now drag and drop files and folders onto the application's dock item.
-
You can now double-click items in the class files table to reveal them in the Finder. You can also double-click in the output directory field to reveal this directory in the Finder.
Bug fix:
-
Fixed a bug where static getter and setter methods were not recognized as belonging to the same property.
Added examples:
- Usage of the @see tag: class
and
doc
- Event handlers - example of event handlers and broadcast messages: class
and
doc
Updated examples:
|
|
1.1.2
|
4 September 2004
|
- Interface updates: folder and file icons in the classes table, and checkboxes to select and deselect folders and files.
- Code examples now have basic color formatting for comments and strings.
- @private keyword is no longer ignored and marks a method or property as private.
- Improved formatting for html code when "preserve linebreaks" is selected.
Bug fixes
- Fixed a bug that crashed the app when processing 5 times in a row with the setting "create TOC"
- Fixed a bug that crashed the app when deleting items from the classes table in quick succession
|
|
1.1.1
|
15 August 2004
|
- You can now drag-and-drop files and folders to the Class files table.
- The file counter now indicates the number of valid AS 2.0 class files instead of all .as files.
- For the output directory, you can select the same directory as the input file/dir location by using the shortcut [command-key]+[Select... button].
- Improved formatting of code blocks: normalizes spaces and tabs that are used for indenting code.
- Code text that runs one line is put inside
<code></code> tags; code that spans multiple lines is put inside <pre></pre> tags.
- Repairs wrong tag order of
<blockquote> inside <pre>: <pre><blockquote> becomes <blockquote><pre>.
- Repairs wrong closing tag order of blockquote.
- Improved frameset layout, with a full-height leftbar.
- CSS support for <tt> tag.
Bug fixes
- Hides tag @property.
- No html files are written if there are no valid AS 2.0 class files.
- Registration window functions properly again.
|
|
1.1
|
23 July 2004
|
- 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 asterisks are ignored and documenation text flows as wide as possible).
- It is no longer necessary in doc comments to start each line with a asterisk - this is equivalent to Javadoc version 1.4.
Usage note
- If you select the option "Preserve linebreaks", each line will be printed on a new line.
You can use either stars or no stars and any number of tabs.
- 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></pre>.
- Minor change to css to give
<pre> blocks a top and bottom margins of 1em.
Usage note
- If you want to have running text with a code fragment in it, use this format:
<code> your code fragment with no linebreaks </code>
- 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 ( // ) 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.
Added examples:
- Distinguish class and instance members: class
and
doc
- Input variations - example of VisDoc's forgiving nature for varied (messy) doc texts: class
and
doc
- Interfaces: class
and
docs
- Linebreaks - Preserving linebreaks:
class
and
doc, not preserving linebreaks: class
and
doc
|
|
1.0.4
|
17 July 2004
|
- VisDoc now creates a frameset index.html and a Table of Contents toc.html.
- The stylesheet is written to the directory 'css'; the javascript files to the directory 'js'.
Usage note
- If you deselect the option "Generate TOC and index page" the links "show TOC" and "hide TOC" at the bottom of each page will be omitted too.
Bug fixes
- Fixed a bug where properties without doc comment where not listed.
- Fixed a bug where a square bracket inside a function would lead VisDoc to think there where less methods in the class then there actually where.
- XML data is now properly encoded as UTF-8 when writing XML files, so 'strange' characters like a © sign now appear normally in XML output.
|
|
1.0.3
|
8 July 2004
|
- Methods and properties are now sorted, while the summary list keeps the order of the class file.
|
|
1.0
|
7 July 2004
|
|
