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.
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.
Lightbox .NET Documentation, Class Overview Page
Overview of a .NET class, including an automatically generated Object Relationship Diagram, Inheritance Hierarchy and Syntax in multiple .NET languages.
Lightbox .NET Documentation, Constructor Overload Page
Page for a specific .NET constructor overload, including a link to the method summary page listing other overloads.
Lightbox COM Documentation, Class Overview Page
Overview of the COM class, including an automatically generated Object Relationship Diagram.
Lightbox XSD Documentation, Complex Type Page
Page generated for an XSD Complex Type, including a type diagram, overview data tree and XSD Source Code.
Lightbox Javascript Documentation, Method Page
Page generated for a Javascript method, documenting the syntax and parameters.
Lightbox Database Documentation, Table Page
Page generated for a Table, including Properties, Columns, Indexes, Relationships and SQL Source (where available). Also includes dependencies if documenting a Sql Server database.
Lightbox Web Service Documentation, GET Operation Page
Page generated for a GET Operation in a REST Web Service. Details the parameters, request/response data types and any fault responses.
Lightbox Web Service Documentation, Method Page
Page generated for a SOAP Web Service method. Details the parameters, request/response data types and any fault responses.
Lightbox Web Service and XSD Schema Documentation, Diagrams
Schema diagrams are automatically generated for web service operations that use XSD Types and XSD documentation pages.
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.
Lightbox Content File Editor
In combination with, or as an alternative to authoring content in JSDoc or Xml format source code comments, create and maintain documentation content using the Document! X Content File Editor.
Lightbox Leverage JsDoc format source comments
Document! X will automatically use any JsDoc format source code comments and use them in the generated output.
Lightbox Leverage Xml format source comments
Document! X will automatically use any Microsoft xml format source code comments and use them in the generated output.
Lightbox Example Code Designer
A specific designer is included in the Content File Editor to make creating examples quick and easy. Paste example code or use existing code files (or named regions within them) as your source.
Lightbox Automatically Generated Syntax
Document! X will automatically generate a Syntax and Usage section in member pages. Regular Javascript syntax, or a specific syntax for jQuery libraries and widgets is output as appropriate.
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 a Database
This short introductory movie will take you through the process of creating a new Document! X Project for a Database (7 minutes).
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).
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)
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)
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)
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).
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)
Finding Undocumented Items
This movie provides a quick introduction to finding items in a project that still require documentation by using the Undocumented Items tool. (4 mins)
Using Document! X with Visual Studio 2010
This movie demonstrates how Document! X integrates with Visual Studio 2010 and how it can become part of a routine development documentation workflow (5 mins).
Introduction to Source Control
This video provides a demonstration on how to enable Source Control functionality, add a project to Source Control and access Source Control features in a Source Control enabled project. (6 mins)
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)
Introduction to Localization features
This video will demonstrate how to use the localization features by enabling localization and creating both an English and Japanese output from the Document! X .NET sample project (9 mins).
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)
Benefits of using Document! X
Using an automated documentation tool immediately delivers the following benefits:
- 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;
- The documentation generated by Document! X is accurate and always up to date. Creating the same documentation manually is error prone;
- Producing a documentation set for your Javascript library makes it more maintainable as there is a structured reference to accompany the source code;
Products
Community
+1 (617) 275-2261
+44 844 884 2673
sales@innovasys.com
Contact Us | Terms and Conditions | Privacy Policy
Copyright @2016 Innovasys Limited. All Rights Reserved.
Document! X 2016.1
HelpStudio 2016.1