Document! X 2008 Release Note

6.1.1.5

Released on 6/26/2009

This minor update contains a small number of fixes for issues discovered since the the 6.1.1.2 release.

Unrecognized element messages in the header area of the Assembly overview page in .NET 2008 style template output
Setting XSD diagrams to use custom colors can result in runtime error during the build

6.1.1.2

Released on 3/25/2009

This minor update contains a small number of fixes for issues discovered since the the 6.1.0.1 release, including issues affecting machines with IE8 installed.

When building an ActiveX documentation project immediately after loading it in Document! X, some excluded modules are included
Visual Studio hang / pauses when Document! X AddIn loaded
Errors thrown in Topic editor when running Document! X on a system with IE8 installed

6.1.1.1

Released on 3/24/2009

This minor update contains a small number of fixes for issues discovered since the the 6.1.0.1 release, including issues affecting machines with IE8 installed.

When building an ActiveX documentation project immediately after loading it in Document! X, some excluded modules are included
Visual Studio hang / pauses when Document! X AddIn loaded
Errors thrown in Topic editor when running Document! X on a system with IE8 installed

6.1.0.1

Released on 6/24/2008

This update contains fixes for a number of issues discovered since the 6.0.0.19 release.

Inserting an Image functionality has been improved

Inserting an image now displays a dialog allowing you to select an existing Additional File, local image file or internet URL. When adding a local image file, it can automatically be added to the related Document! X project Additional Files list to ensure it is compiled into any generated compiled help file.

Document! X was not locating hhc.exe path on x64
Problems with <see> links containing ":" character in the title
Help compiler crash and/or output fails when building to a very long path and filename

Document! X now issues a warning when an output path and filename exceed the windows limitation. Building to a shorter output path, or using the 'Generate alias filenames' option on the 'Microsoft .NET Options' page in the Document! X Project Editor will resolve this problem.

Link in the design time banner to select the item used by Content From was not working when the linked item was in same class
Content From (<commentsfrom> XML comment) not created correctly when Copy / Paste comments toolbar buttons used in VS
If all items of a certain type are unticked on the Included Modules page, the container folder still stays ticked

This behavior was misleading as it made it difficult to spot when all items of a certain type (.e.g database roles) had been unticked.

Project find and replace was auto completing in incorrect case
Enumerations included in generated ActiveX output even if excluded on the Included Modules page
HTML Help compiler issues warnings about object diagram images generated for nested classes

This problem was caused by a bug in the HTML Help compiler related to image filenames containing the characters ".h" - this was causing the HTML Help compiler to incorrectly parse those files as HTML files.

VB Projects always appear sorted alphabetically in Table of Contents

A new filter property has been added to allow Table of Contents to be configured such that projects appear in the order that they were added to the Document! X project, rather than being sorted alphabetically (default). To use this new filter property, set the Table of Contents type to Use a custom Table of Contents layout, click on the project node (the node with %%Project_Title%% as it's caption) in the Table of Contents editor and type 'sorted=false' in the Filter String field under the Content Driven option.

Runtime error attempting to add a hotspot to an image in a XSD documentation content file
Custom XML comment file locations set in preferences were not being correclty used if they didn't contain a trailing \ character

This was preventing a custom XML comment file location being set when building help for a language pack language

Linked example pages were not being generated correctly
The <exclude/> tag was not working correctly when used on classes in .NET documentation
Runtime error creating a new documentation project in Visual Studio 2003
Typo in "Creating a new Content Type" help topic
Defaut requirements section in .NET documentation has been updated to include Vista and Windows Server 2008
If the only edit in the page layout editor is a drag and drop, changes are not saved on close
Documentation empty when documenting from a .vbproj encoded as UTF-16
Runtime error generating ASP.NET Ajax documentation with a customized Table of Contents
Error when opening or building a database documentation project containing a content file with content for missing objects
Documentation created for overloads in the Visual Comment Editor are not written back to source
Collapse All and Expand All phrases are transposed in the German language phrase tables
Runtime error when editing a non HTML page layout file

The Document! X page layout editor is designed for editing HTML files. Using the page layout editor to modify the template XML files was causing errors that resulted in blank files being saved. The page layout editor will now open the associated application for editing the particular file type on the local machine instead of the built in editor for non HTML files.

Runtime error documenting an XML Schema
Runtime error documenting a database table with a foreign key relationship to a table in a different schema (SQL 2005)
Runtime error trying to create a new Document! X project with a solution open containing a WISE installer project
Runtime error when creating a new documentation project in Visual Studio
"Include this items" list on Filters page in project editor is blank
Field descriptions in ASP.NET Ajax javascript files are not picked up
Runtime error after modifying Ajax project details in an ASP.NET Ajax documentation project
Paramref comment contained in an <exception> or <permission> tag doesn't resolve correctly if there is a method of the same name
Deselecting database users that contain a \ character are not preserved when the project is reloaded
XSD Diagram inconsistencies where inherited types and elements span multiple schemas
Runtime error documenting a SQL database schema
Abstract members marked as virtual abstract in C# syntax. The virtual keyword is redundant.
Examples containing HTML characters created using the Visual Comment Editor not written back to source correctly
Runtime error documenting an Oracle schema containing some oracle system tables and indexes

6.0.0.19

Released on 2/28/2008

This minor update corrects an issue that caused Ajax syntax sections to appear in .NET output.

Ajax syntax sections appearing in .NET output if one or more languages unticked in .NET Options

6.0.0.18

Released on 2/22/2008

This minor update corrects a problem with the ASP.NET Ajax sample project.

Sample ASP.NET Ajax project won't compile to Help 2.x
Namespace hierarchy link from Namespace overview page in ASP.NET Ajax sample does not work

6.0.0.17

Released on 2/21/2008

This minor update contains corrections for a setup issue discovered since the initial release.

Initial Release Update

Released on 2/19/2008

This minor update addresses a problem that was causing the Document! X 2008 setup to fail.

ASP.NET Ajax Javascript documentation

Document! X can now document ASP.NET Ajax Javascript libraries, either directly from .js files, or from embedded assembly resources. The generated output includes object relationship diagrams, inheritance hierarchies, and Ajax syntax blocks. Existing XML format source comments are used where available. As with the other Document! X documentation types, Content Files can be used to author additional content to supplement the source comments.

New Visual Studio 2008 style templates

Document! X includes new templates modelled on the Visual Studio 2008 documentation style. The templates have been implemented for all documentation types.

Full support for Community Extensions features

Document! X 2008 includes a page in the Project Editor to enable Community Extensions functionality when using the 2005 or 2008 templates. Community Extensions allows you to provide web 2.0 community features in your help systems with zero effort. Just tick the 'Enable Community Extensions' tick box in the Build Profile, select the Community Extensions server you wish to use (an evaluation server is available without any setup required), and your help system will include rich community features (private notes, comments and ratings).

Visual Studio 2008 Integration

Document! X 2008 includes full Visual Studio 2008 support, including integration with the Visual Studio 2008 IDE and the Document! X Visual Comment Editor.

Documentation for overload of default (item) property in a C++/CLI assembly
Runtime error creating a Document! X project from a Visual Studio solution containing a WiX project
When using the Visual Comment Editor window undocked, it was sometimes left open after exiting Visual Studio
Column widths in member tables in the 2005 and 2008 style templates have been adjusted to leave more room for descriptions
^ (reference type) modifier missing for some types in the C++/CLI syntax
Event syntax was including a suffix of empty brackets in the C++/CLI syntax
Excluding a class using the <exclude/> tagged comment was not correctly excluding the class from the generated documentation
Content from XML documentaiton file not extracted for some .NET classes with constructors having generic parameter types
For references to nested classes / enumerations, Document! X now uses the :: scope operator in CPP/CLI syntax
Missing .NET members when documenting an assembly with missing dependancies
The Remove Intermediate Files option was removing the COL_ files necessary when deploying a Help 2.x project
Methods in C++/CLI assemblies that return value types by ref are documented incorrectly with a System.ValueType return type
Parameter description for a method with generic arguments in a C++/CLI assembly not documented
Value parameter for the property set block in the C++ syntax was shown incorrectly as a hyperlink
Runtime error opening the example designer on a machine with HelpStudio 3 installed
Implicit operator for a generic type parameter not documented
In a class containing multiple implicit operators, only the first was documented
C++/CLI syntax for implicit operators was incorrect
Override specifier shown in the wrong position in C++/CLI syntax
raise_ compiler generated .NET event member shown in generated documentation
Int64 parameters and return types shown as "long" instead of "long long" in C++/CLI syntax
Special characters in documentation title (.e.g. &) = failed compile if output type Help 2.x
The link to open a Help 2.x output was not working with some combinations of Visual Studio versions
Classes containing a private static constructor are documented with the matching instance constructor also marked private
Typo in tooltip for the Auto Expand toolbar button in the Visual Comment Editor in Visual Studio
Methods with a generic dictionary as a parameter not showing documentation from the XML documentation file
Document! X will no longer include constructors for abstract classes in the generated documentation
Array parameters incorrectly documented in C++/CLI syntax
For C++/CLI assemblies, the IsImplicitlyDeReferenced and IsExplicitlyDeReferenced modifiers were not being used

The C++/CLI compiler adds required modifiers to parameters to indicate reference parameters. Document! X now looks for and uses those parameter modifiers in order to correctly document reference parameters (tracking references).

Documentation not extracted from XML documentation file for the assignment operator

Initial Release

Released on 2/15/2008

Value parameter for the property set block in the C++ syntax was shown incorrectly as a hyperlink
Typo in tooltip for the Auto Expand toolbar button in the Visual Comment Editor in Visual Studio
Override specifier shown in the wrong position in C++/CLI syntax
Column widths in member tables in the 2005 and 2008 style templates have been adjusted to leave more room for descriptions
Runtime error opening the example designer on a machine with HelpStudio 3 installed
For C++/CLI assemblies, the IsImplicitlyDeReferenced and IsExplicitlyDeReferenced modifiers were not being used

The C++/CLI compiler adds required modifiers to parameters to indicate reference parameters. Document! X now looks for and uses those parameter modifiers in order to correctly document reference parameters (tracking references).

Methods with a generic dictionary as a parameter not showing documentation from the XML documentation file
Int64 parameters and return types shown as "long" instead of "long long" in C++/CLI syntax
Array parameters incorrectly documented in C++/CLI syntax
Special characters in documentation title (.e.g. &) = failed compile if output type Help 2.x
Event syntax was including a suffix of empty brackets in the C++/CLI syntax
Classes containing a private static constructor are documented with the matching instance constructor also marked private
Missing .NET members when documenting an assembly with missing dependancies
Implicit operator for a generic type parameter not documented
Parameter description for a method with generic arguments in a C++/CLI assembly not documented
Methods in C++/CLI assemblies that return value types by ref are documented incorrectly with a System.ValueType return type
Content from XML documentaiton file not extracted for some .NET classes with constructors having generic parameter types
For references to nested classes / enumerations, Document! X now uses the :: scope operator in CPP/CLI syntax
C++/CLI syntax for implicit operators was incorrect
Runtime error creating a Document! X project from a Visual Studio solution containing a WiX project
The link to open a Help 2.x output was not working with some combinations of Visual Studio versions
Documentation not extracted from XML documentation file for the assignment operator
Documentation for overload of default (item) property in a C++/CLI assembly
When using the Visual Comment Editor window undocked, it was sometimes left open after exiting Visual Studio
The Remove Intermediate Files option was removing the COL_ files necessary when deploying a Help 2.x project
In a class containing multiple implicit operators, only the first was documented
^ (reference type) modifier missing for some types in the C++/CLI syntax
raise_ compiler generated .NET event member shown in generated documentation
Document! X will no longer include constructors for abstract classes in the generated documentation
Excluding a class using the <exclude/> tagged comment was not correctly excluding the class from the generated documentation