Document! X for Java Documentation
Document! X fully supports documentation of Java projects.
View a movie demonstrating how Document! X can quickly and easily create documentation for a Java Project
View samples of Java documentation generated by Document! X
Documentation style and functionality
The standard template has a modern and recognizable style consisting of a header area containing the page title and links to key sections of the current topic and a scrollable body area. Users of the documentation you produce will be immediately familiar with the structure, layout, style and functionality.
Download a free evaluation version
Content from Source
Document! X will use any Javadoc source comments that exist in the Java source you are documenting, so you can leverage any existing documentation effort.
Content outside Source
You can choose to author content in the Document! X Content File editor. Content can be configured to extend (combine with) or override any existing Javadoc source comments according to your preference. This approach allows you to include basic documentation in the source code and use the rich Document! X Content File editor to supplement it (e.g. with examples, more detailed descriptions etc.).
The Document! X Content File editor can show you the Javadoc source comments whilst you are editing, so that you can instantly see where the source documentation might require additional detail or replacement.
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).
The template based configuration that Document! X is based on makes it easy to:
- Add additional standard content to the generated documentation (for example a glossary or company information);
- Adapt templates to match your existing corporate style and color scheme;
- Customize Table of Contents definitions according to your requirements;
- Fine tune the standard phrases and terminology used by Document! X to match your standards.
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.