Document! X for COM (ActiveX) Documentation
Document! X fully supports documentation of compiled COM components, controls or Type
Libraries, created using any programming language.
Documentation style and functionality
Several COM documentation templates are provided - ranging from the original .NET documentation style, through to the latest Visual Studio 2005 and 2008 styles.
Documentation you generate will be familiar in structure, layout, style and functionality to your COM developers.
Authoring content
The Document! X Content File Editor allows you to author additional content for inclusion in the generated documentation. The full featured HTML Editor, Dynamic and Project
Spell Check, Find and Replace and Link Check tools make authoring activities as productive as possible.
If you have already defined HelpStrings in your COM Component or Type Library, Document! X can use them as summary text for the generated documentation.
Context Sensitivity
If you have defined Help Context IDs for your COM Components members, Document! X will ensure that all topics are given matching Context IDs such that context
sensitive help called when the component is being used will invoke the correct help topic.
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.
Customization
The template based configuration that Document! X is based on makes it easy to:
- Create new comment types for use in source code comments;
- Add additional standard content to the generated documentation (for example a glossary or company information);
- Adapt existing 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.
Help where you need it
The Document! X IDE includes a comprehensive help system, including a Contents, Index and Dynamic Help window. The Dynamic Help window provides a list of help topics,
tutorials, getting started guides and movies relevant to your current activity enabling both new and experienced users to get to grips with Document! X functionality as quickly as
possible.
Document! X includes several printable 'Getting Started' PDF booklets to enable you to get immediate results from Document! X.
Authoring examples
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.
Localization
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.
Model Comments - re-usable common descriptions
Model Comments allow you to define common descriptions in a model comment profile for re-use in future projects. For example, ActiveX controls usually support a set of
common properties and events (e.g. KeyPress event, BackColor property) - Model Comments allow you to define descriptions for these members once and have Document! X use them
wherever the members appear in order to reduce duplication and effort.