Generating HTML documentation from ScriptDoc

This Help topic describes how to generate HTML documentation from your ScriptDoc comment blocks.

Introduction

If you document your JavaScript code using ScriptDoc, you can generate reference documentation in HTML from your Script Doc comment blocks.

Note: This feature currently only works for JavaScript files, not JavaScript code documented in separate .sdoc files.

Instructions

To generate HTML docs from your JavaScript code:

1. Open your JavaScript file in the Editor.
2. Document your functions using ScriptDoc comment blocks. See Documenting your code using ScriptDoc for instructions.
3. In the Aptana toolbar, click the Generate HTML Docs button to generate the documentation.

Aptana creates a new folder in the same folder as your sdoc'ed JavaScript file and generates the HTML documentation. The documentation is based on what is displayed in your Outline View.

Related Topics

• About Code Assist
• Displaying Code Assist
• Setting up Code Assist using ScriptDoc
• Documenting your code using ScriptDoc
• Documenting your code in an .sdoc file
• Documenting dynamic properties and functions with ScriptDoc
• Documenting inheritance with ScriptDoc
• Using Open Declaration to jump to a function in your code
• ScriptDoc comprehensive tag reference
• ScriptDoc tag quick reference