Document! X Info Pages:

Javascript Documentation

Document! X - Javascript Documentation Tool

Document! X is a combination of an automated Javascript documentation tool and a full documentation authoring environment which can be used to create accurate, professional quality database documentation for plain Javascript, jQuery plugins and jQuery UI Widgets.

Document! X is not just an automated Javascript documentation build tool - it is also includes a fully featured documentation authoring environment allowing you to author supplementary content (descriptions of types, functions, fields and events; hyperlinks to related pages or web sites etc.) where required.

Download a Free Trial Version

Why Choose Document! X for Javascript Documentation?

  • Fast, accurate, professional quality Javascript documentation;
  • Market leading authoring tools for creating supplementary content;
  • Document types, enumerations, interfaces, functions, fields, events, jQuery plugins, jQuery UI Widgets, asynchronous module definitions;
  • Customizable HTML based template driven output can be adapted to your requirements;
  • Generate documentation to HTML Help 1.x (CHM) and/or web ready pure HTML including a full Table of Contents, Index and Full Text Search.

Sample Outputs

These sample outputs illustrate how much can be generated by Document! X right out of the box. All of the Document! X Templates are fully customizable and can be easily adapted or extended to meet your specific requirements.

Live Samples

Author Content in Jsdoc or Xml Source Comments

Document! X will use the content of Javascript source comments where available; both JsDoc and Xml format source comments are supported. Use @returns, @param and @type comment tags to identify function, parameter and field types to improve the quality of the automatically generated usage sections.

JsDoc Format

/**
* constructs a new myType object
* @constructor
* @param {string} p1 p1 summary
* @param {number} p2 p2 summary
*/
function myType(p1, p2) {

}

/** field summary */
myType.prototype.field = 0;

/**
* method summary
* @param {string} p1 p1 summary
* @returns {number} method returns
*/
myType.prototype.method = function(p1) {

}

Xml Format

function myType(p1, p2) {
    ///<summary>constructs a new myType object</summary>
    ///<param name="p1" type="string">p1 summary</param>
    ///<param name="p2" type="number">p2 summary</param>
}

///<summary>field summary</summary>
myType.prototype.field = 0;

///<summary>method summary</summary>
///<param name="p1" type="string">p1 summary</param>
///<returns type="number">method returns</returns>
myType.prototype.method = function(p1) {
}

Authoring Additional Content Outside Source

You can also author content in Document! X Content Files if you would like to maintain some or all of the database documentation content outside of the source code.

The full featured HTML Editor, Dynamic and Project Spell Check, Find and Replace and Link Check tools make authoring activities as productive as possible.

Object Model Diagrams

Document! X automatically generates object relationship diagrams for your classes. Specific relationships can be ignored where necessary (e.g. a relationship back to a parent object).

Demonstration Movies

These short movies provide a great way to discover what can be achieved using Document! X.

Documenting an Xsd Schema

This movie will take you through the process of producing documentation from an XSD Schema file using Document! X. (10 mins)

View this Movie

Documenting a Javascript Library

This movie will demonstrate how Document! X can be used to create documentation for Javascript, both simple javascript function libraries as well as javascript object models and jQuery plugins and widgets. (13 mins)

View this Movie

Documenting a Web Service

This movie will take you through the process of producing documentation for a Web Service (SOAP or REST) using Document! X. (11 mins)

View this Movie

Documenting .NET Assemblies

This introductory movie will take you through the process of creating a new Document! X Project for one or more Microsoft .NET Assemblies (13 minutes).

View this Movie

Documenting a Database

This short introductory movie will take you through the process of creating a new Document! X Project for a Database (7 minutes).

View this Movie

Documenting a COM Component

This short introductory movie will take you through the process of creating a new Document! X Project for a COM Component or Type Library (6 minutes).

View this Movie

Publishing to a web site, ftp server or network location

This movie demonstrates the new Publishing functionality introduced in 2015.1. Publishing makes it easy to publish output generated by Document! X or HelpStudio to a web server or network location. A range of publishing methods are supported; you can publish to an Azure web site, a web site running on IIS, a web site that supports uploading via ftp, or directly to a local network path. (11 mins)

View this Movie

Automatic optimization for Tablet and Mobile devices

This video demonstrates how the Responsive Output feature allows you to generate content that automatically adapts to the device type of the browser, providing an optimal experience for Mobile, Tablet and Desktop users from a single output. (5 mins)

View this Movie

Using Build Profiles to create multiple outputs

This short video provides a demonstration of how you can configure a project to create multiple outputs from a single source, with each output driven by a separate options defined in the Build Profile. (3 minutes)

View this Movie

More Movies

Benefits of using Document! X

Using an automated documentation tool immediately delivers the following benefits:

  1. Javascript documentation can be built by Document! X in moments, reducing the amount of manual effort involved in creating a documentation set to virtually zero;
  2. The documentation generated by Document! X is accurate and always up to date. Creating the same documentation manually is error prone;
  3. Producing a documentation set for your Javascript library makes it more maintainable as there is a structured reference to accompany the source code;

Download a Free Trial Version