Glossary Item Box

Document! X for ASP.NET Ajax Developers

Document! X fully supports documentation of ASP.NET Ajax Client Javascript files, either from disk files, or from embedded assembly resources.

View a movie demonstrating how Document! X can quickly and easily create documentation for an ASP.NET Ajax Javascript library

Documentation style and functionality

Templates are provided for Visual Studio 2005, Visual Studio 2008 and Visual Studio 2010 (Microsoft Help Viewer) documentation style, so users of the documentation you produce will be familiar with the structure, layout, style and functionality.

Content from Source

Document! X will use any XML format source comments that exist in the ASP.NET Ajax Client Javascript 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 XML format source comments according to your preference. This approach allows you to include basic documentation in the ASP.NET Ajax Client Javascript 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 XML format 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).

Customization

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 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.  

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.