Document! X delivers the best of both worlds by seamlessly combining automatic documentation of Javascript files (plain Javascript or jQuery plugins / Widgets) with a full WYSIWYG authoring environment. The generated content is an accurate and comprehensive documentation set for your Javascript library covering classes, structures, interfaces, enumerations, constructors, methods, properties, events and fields.
Document! X uses a unique approach to analyzing your javascript that ensures an accurate documentation set regardless of the framework or inheritance pattern you have chosen to use.
Document! X will use any existing Jsdoc or XML format source code comments and you can extend the source descriptions using the rich authoring environment provided by the Document! X Content File Editor.
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 Overview of the Javascript Library, listing the documented Namespaces, jQuery Plugins and jQuery Widgets.
Lightbox Page generated for a jQuery plugin, documenting the syntax, options and methods.
Lightbox Details the members (methods, properties, fields, events) of a documented type.
If you have use Jsdoc comments or XML format comments in your Javascript source code, Document! X can use them automatically; you can view the content of the source comments whilst you are editing in order to easily spot areas that need expansion and avoid duplication.
You can choose to author content in your Jsdoc or XML format source comments, and/or using the rich authoring environment of the Document! X Content File editor. This flexibility allows you to include basic descriptive documentation in the source code and use the feature rich Document! X Content File editor to author extended content.
Lightbox 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 Document! X will automatically use any JsDoc format source code comments and use them in the generated output.
Lightbox Document! X will automatically use any Microsoft xml format source code comments and use them in the generated output.
Lightbox 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 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.
Document! X will use any JsDoc or XML format source comments that exist in the Javascript you are documenting, so you can leverage any existing documentation effort. Adding type information in your source comments will improve the level of documentation Document! X is able to produce for your members.
/** * 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) { }
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) { }
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).
Your Javascript documentation projects can be generated to Browser Help or CHM (Html Help 1.x). The specific requirements for the different output formats are handled for your automatically and you can build all outputs from a single project. Automatic publishing makes it quick and simple to deploy the generated output to your web site, ftp server or network location.
Lightbox Browser Help output is viewable directly in the web browser, so is the ideal format for publishing documentation on a web site or intranet site. The browser help output includes a Table of Contents, Index and Full Text Search.
Lightbox The automatically generated responsive support allows you to generate a single output that automatically adapts to the device profile; delivering an optimal browsing experience for Desktop, Tablet and Mobile from a single output. Tablet and Mobile devices benefit from buttonized links, a button based fly out Table of Contents and other automatic features that dramatically improve the end user experience.
Lightbox Html Help 1.x (CHM) is the Microsoft Windows compiled help file format. When building to CHM, the output is a single file that can be deployed to, and viewed on, any machine with Windows installed. The CHM viewer includes a Table of Contents, Index and Full Text Search.
Lightbox Your built documentation can be automatically published to a range of locations; a network path, ftp server, Azure web site or IIS (Internet Information Services) Server. Publishing recongizes which files have changed in the last build, so publishing is quick and minimizes network traffic.
Lightbox The generated output can be automatically integrated with a range of Community Providers (Facebook, Disqus, Livefyre or SolidOpinion) allowing you to include rich community features in your help systems.
The template based configuration that Document! X is based on makes it easy to:
The easy to use Example code designer included in the Content Editors makes adding multi-language examples a breeze. In-line or linked examples can be created and example code is automatically colorized in the generated output.
Document! X supports several different languages (English, French, German, Dutch, Italian and Russian) for the phrases used in the generated output. All of the phrases and terminology in the generated output can be configured according to preference.
Document! X allows you to author content for multiple languages within a single project, showing you an embedded tip for the primary locale content when you are authoring in the Content File Editor for a secondary locale. If you use the Document! X and HelpStudio bundle you can export and import your localized content in XLIFF format; the industry standard for sending and receiving translation content from translation providers.
