Document! X - Tool for Java Documentation
Document! X is a combination of an automated Java documentation tool and a full documentation authoring environment which can be used to create accurate, professional quality documentation for your Java projects.
Document! X is not just an automated documentation build tool - it is also includes a fully featured documentation authoring environment allowing you to create supplementary content (descriptions and remarks for Packages, Types, Interfaces, members, hyperlinks to related pages, example code, index kewords etc.) where required. The authoring tools provide support for technical writers, localization and source control.
Why Choose Document! X for Java Documentation?
- Fast, accurate, professional quality documentation;
- Market leading authoring tools for creating supplementary content;
- Automatically integrates the generated documentation with popular Java IDEs for F1 and tooltip help support;
- Documentation pages generated for library, namespace, class, interface, constructor, method, property, field;
- Generate documentation to HTML Help 1.x (CHM), Help 2.x or web ready pure HTML including a full Table of Contents, Index and Full Text Search.
- Customizable HTML based template driven output can be adapted to your requirements and ships with standard phrases pre-translated to 9 different languages;
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 Javadoc source code comments
Document! X will use any Javadoc format source comments where they are available - including all of the standard comment types defined in the Javadoc specification as well as any additional comment types that you define.
Author documentation content in a Document! X Content File
You can also author content outside of Java source code if you wish, or combine both approaches and have some content in Javadoc source XML comments and some in Document! X Content Files.
This approach is quite common as it allows technical writers to contribute more extensive content or examples, or override content defined in source comments for editorial reasons, without stopping developers from documenting in the source.
The Content File editor includes dynamic spell check, hyperlink designer and designers for example code, permissions, exceptions, index keywords etc.
Lightbox Content File Editor
In combination with, or as an alternative to authoring content in Javadoc source code comments, create and maintain documentation content using the Document! X Content File Editor.
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)
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). Collection objects are automatically recognized and appropriately represented.
Benefits of using Document! X
Using Document! X as your Java documentation solution immediately delivers the following benefits:
- Java documentation can be built by Document! X in moments, reducing the amount of manual effort involved in creating a help system to virtually zero;
- The documentation generated by Document! X is accurate and always up to date. Creating the same documentation manually is error prone and very labor intensive;
- Help for the Java project you have documented can be easily integrated with popular Java IDEs providing instant F1 and tooltip help support for you, your team or your customers;
- Producing a documentation set for your Java library makes it more maintainable as there is a structured reference to accompany the source code and API;
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