Glossary Item Box

Document! X 2013.1 Feature Summary

Complete documentation solution

  • Document Microsoft .NET and Silverlight Assemblies (.NET Framework 1.0 - 4.5), Compiled COM (ActiveX) Components and Controls, Type Libraries, Java Projects, Javascript, Web Services (REST and SOAP), Access/SQL/Other OLEDB Databases and Xml Schemas with a single tool;
  • Produce a single consolidated documentation set for code, components, web services and databases;
  • Use Build Flags and Build Profiles to produce multiple outputs from a single project source (View Movies);
  • Add additional locales to a project to produce multiple outputs translated for different locales (View Movies);
  • Author free format conceptual Topics to supplement the automatically generated content (View Movies);
  • User friendly IDE providing a single environment in which to create and edit projects and content;
  • Documentation can be output with standard terminology automatically translated to German, French, Dutch, Italian, Spanish, Russian, Japanese or Simplified Chinese;
  • Content Editors fully support Unicode for authoring documentation content;
  • Templates are included that mirror documentation styles ranging from Visual Studio 2008 through to the latest Visual Studio 2012 style.

Authoring Tools

  • Revolutionary 'Full page edit' allows content to be edited directly within a preview of the generated page (View Movies);
  • In place designers for creating, editing or removing See Also links and examples;
  • Use the 'Comments From' feature to identify items with common descriptions and therefore reduce content duplication;
  • Visual source comment editor for Visual Basic .NET, C# and C++/CLI (View Movies);
  • Full support for Visual Studio versions 2010 and 2012 (View Movies);
  • Content file editor for authoring content external to the source code (View Movies);
  • Fully featured XHTML editor;
  • Comprehensive CSS Styles features including a Style Picker, Style Editor and integrated Stylesheet editor make it quick and easy to create, manage and apply re-usable styles (View Movies);
  • The Page Map provides a visual map of the page being edited, simplifying manipulation of complex content such as tables and lists.
  • Point and Click linking to any other item or member in the documentation (View Movies);
  • Point and Click linking to a conceptual topic (View Movies);
  • Dynamic and project-wide spell checking (View Movies);
  • Project-wide link checker (View Movies);
  • Project-wide find and replace, including Regular Expression support (View Movies);
  • Create Content Files for any item being documented in order to author additional content;
  • Create Content files to supplement the content extracted from source comments;
  • View source comments whilst editing Document! X Content Files in order to understand what needs to be edited / supplemented.

Project Customization

  • Easily include additional content (image files, diagrams, web links);
  • Customize the Table of Contents layout (View Movies);
  • Provide property values for use in the output, such as Copyright Notice and Feedback Link; 

Global Customization

  • Define new content types that can be used in C#/VB/VB.NET/C++CLI/Javascript/T-SQL source code comments and the Content File editor (e.g. a <history> comment type) and output in the documentation (View Movies);
  • Visual page layout editor to allow customization of page layout content, look and feel;
  • Add additional standard pages to the generated documentation (for example a glossary or company information) (View Movies);
  • Create new Table of Contents layouts for re-use in multiple projects;
  • Customize the standard phrases and terminology used in the generated documentation;
  • Define new Template Properties for including project specific information whose value can be defined on a project by project basis;

.NET and Silverlight Documentation

  • Visual source comment editor for Visual Basic.NET, C# and C++/CLI allowing developers to author additional content directly within a preview of the automatically generated page (View Movies);
  • Uses existing .NET Xml comments where available. All standard Xml comment types are used and several new types are provided by Document! X (<isnew/>, <commentsfrom>, <keywords> etc.) (View Movies);
  • Uses existing XML format source code comments. All the standard XML source comment types are used;
  • Uses existing descriptions for inherited members (e.g. members inherited from the .NET framework assemblies);
  • Full hierarchical graphical relationship diagrams and inheritance trees generated for each class and namespace;
  • Generated documentation is fully linked to the .NET framework documentation (for inherited members, base types etc.);
  • Create, open and build documentation projects from within the Visual Studio;
  • Automatically generates Visual Studio dynamic help system integration. Users of Visual Studio have instant access to the relevant documentation topic when coding against documented assemblies;
  • Command line tool (InnovaHxReg) for deploying documentation to other machines and integrating with Visual Studio 2002-2008;
  • Colorized example code;
  • Documentation of Generics (classes and methods / properties) and Operators.

COM (ActiveX) Documentation

  • Automatically generates and cross-links all necessary Help Context IDs to support context sensitive help (users press F1 whilst coding with your component or navigating the object browser and the correct topic is shown);
  • Uses any existing HelpStrings from the components type library to provide a summary description where no specific summary is available;
  • Full hierarchical graphical relationship diagrams;

Java Documentation

  • Can use all Javadoc comments in your Java source;
  • A fresh and modern look and feel that will be instantly familiar to users of the generated documentation;
  • Automatically generates the files necessary to integrate your Java documentation with popular Java IDEs;
  • Full hierarchical graphical relationship diagrams and inheritance trees.

Web Service Documentation

  • Reads web service definitions directly from WSDL, WADL, Swagger definitions or WCF Help Pages;
  • Support for both SOAP and REST web services;
  • The web service definition can be customized or extended within Document! X whilst still updating automatically if additional items are added to the source definition;
  • Embedded XSD Xml Schemas or Json Schemas are automatically documented, including graphical diagrams for XSDs;
  • Existing descriptions embedded within the source web service definition are used where available;
  • Colorized sample data.

Database Documentation

  • Document Tables, Columns, Indexes, Table Relationships, Views, Stored Procedures, Triggers User Defined Functions and Data Types (View Movies);
  • When documenting SQL Server databases, document users, roles, file groups, defaults, rules, check constraints and full text catalogs;
  • When documenting SQL Server databases, document permissions and dependancies between database objects;
  • Extract comments from SQL source code;
  • Colorized SQL source code output;
  • Use existing descriptions created in the SQL Server Enterprise manager, or using the extended properties mechanism.

XSD Schema / implied XML Schema Documentation

  • Document Elements, Simple Types, Complex Types, Groups, Attribute Groups, Attributes, Facets and Constraints;
  • Colorized Xml Schema source output;
  • Graphical diagrams for each documented schema item;
  • Overview tables provide an easy to read overview of complex schema relationships;
  • Existing content in <annotation> documentation blocks can be used;
  • Source comments can be extended or overriden using Document! X Content Files.

Javascript Documentation

  • Document Namespaces, Classes, Interfaces, Enumerations Methods and Fields as well as jQuery plugins and jQuery UI Widgets (View Movies);
  • XML or JsDoc format source comments are extracted and used in the documentation. Additional type information can be defined in the source comments in order to enhance the usability of the generated documentation;
  • Automatically generated specification and usage sections enhance the usability of documented Javascript;
  • Object relationship diagrams are produced automatically from the relationships between classes;
  • Object and Namespace inheritance hierarchies are automatically documented;
  • Source comments can be extended or overriden using Document! X Content Files.