Tuesday, 18 December 2007

ASP Documentation Tool 7.3

The ASP Documentation Tool™ creates comprehensive technical documentation for ASP web applications written in either VBScript or JScript.
Any Microsoft SQL Server 7.0, 2000, 2005 databases, Microsoft Access databases and Visual Basic 6.0 COM objects associated with the application can also be documented if required.

Reports are created in HTML [sample], Microsoft's HTML Help [sample] and text [sample] formats. Color coded, syntax highlighted copies of the ASP, SQL and VB code are included with the reports. The compiled HTML Help reports include fully searchable source code, making the
ASP Documentation Tool™ an invaluable utility in understanding your (or someone else's!) ASP web applications. A version for ASP.NET which supports VB.NET and C# is also available.

Changes in version 7.3 are:


  • Entities such as functions, subroutines and constants are now shown in case-insensitive alphabetical order.

  • Stopped single lines with just a single quote from showing in VBScript function comments.

Download the ASP Documentation Tool Evaluation VersionDownload the ASP Documentation Tool Trial Version

VB.NET Error Handling Using Try ... Catch Blocks

Added a new VB.NET tutorial article to the website:

Monday, 10 December 2007

SQL Documentation Tool 7.2 for SQL Server

The SQL Documentation Tool is a complete documentation solution for Microsoft SQL Server databases. It automatically creates comprehensive technical documentation reports for databases, saving valuable developer time and money.

Reports are created in HTML [sample], Microsoft's HTML Help [sample], RTF [sample] and text [sample] formats. Color coded, syntax highlighted copies of the Transact SQL associated with stored procedures, functions and views are included with the reports. The compiled HTML Help reports includes an index and search facility.

Version 7.2 offers the following update:


  • Database stored procedures are now listed in the RTF format report, complete with optional colour coding and syntax highlighting of the Transact SQL. Note that some RTF documents may need to be imported into WordPad and saved again before they can be opened with Microsoft Word.

  • Table indexes are now listed on the table details page.

Download the SQL Documentation Tool Evaluation VersionDownload SQL Documentation Tool Trial Version

Monday, 26 November 2007

ASP Documentation Tool 7.2

The ASP Documentation Tool™ creates comprehensive technical documentation for ASP web applications written in either VBScript or JScript.
Any Microsoft SQL Server, Microsoft Access databases and Visual Basic 6.0 COM objects associated with the application can also be documented if required.

Reports are created in HTML [sample], Microsoft's HTML Help [sample] and text [sample] formats. Color coded, syntax highlighted copies of the ASP, SQL and VB code are included with the reports. The compiled HTML Help reports include fully searchable source code, making the
ASP Documentation Tool™ an invaluable utility in understanding your (or someone
else's!) ASP web applications. A version for the .NET Framework (C#/VB.NET) is also available.

Changes in version 7.2 are:


  • Source code pages now link back to the page details page.

  • ADO command timeout increased to 2 minutes in database documentation routines.

  • CDO, MAPI and AmHTML objects now reported in appropriate case.

Download the ASP Documentation Tool Evaluation VersionASP Documentation Tool Trial Version

Wednesday, 14 November 2007

.NET Documentation Tool 8.3

The .NET Documentation Tool creates comprehensive technical software documentation for .NET Framework applications written in VB.NET or C#. Microsoft SQL Server and Microsoft Access databases associated with the application may also be documented if required. There is enhanced functionality for documenting ASP.NET web applications.

Reports are created in HTML [sample], Microsoft's HTML Help [sample] and text [sample] formats. Color coded, syntax highlighted copies of the .NET and SQL code are included with the reports. The compiled HTML Help reports include fully searchable source code, making the
.NET Documentation Tool an invaluable utility in understanding application source code. Versions for ASP and Visual Basic 6.0 are also available.

Changes in version 8.3 of the .NET Documentation Tool are:


  • In response to user requests, it is now possible to specify a string of HTML that can be added to the HEAD portion of the HTML files created by the .NET Documentation Tool. An example use of this is to allow a Cascading Style Sheet (CSS) file to be specified.
  • Improved the detection of C# and VB.NET properties.
  • Improved the detection of C# and VB.NET items.
  • Improved the detection of C# and VB.NET subroutines.


Download the .NET Documentation Tool Evaluation Version.NET Documentation Tool Trial Version

Wednesday, 31 October 2007

ASP Documentation Tool 7.1

The ASP Documentation Tool™ creates comprehensive technical documentation for ASP web applications written in either VBScript or JScript.
Any Microsoft SQL Server, Microsoft Access databases and Visual Basic 6.0 COM objects associated with the application can also be documented if required.

Reports are created in HTML [sample], Microsoft's HTML Help [sample] and text [sample] formats. Color coded, syntax highlighted copies of the ASP, SQL and VB code are included with the reports. The compiled HTML Help reports include fully searchable source code, making the
ASP Documentation Tool™ an invaluable utility in understanding your (or someone
else's!) ASP web applications. A version for the .NET Framework is also available.

Changes in version 7.1 are:


  • SQL Server 2005 system table sysdiagrams is now excluded from SQL Server database reports.

  • SQL Server 2005 system views owned by user 'sys' are now excluded from SQL Server database reports.

  • The following SQL Server 2005 system stored procedures are no longer documented: 'sp_alterdiagram', 'sp_creatediagram', 'sp_dropdiagram', 'sp_helpdiagramdefinition', 'sp_helpdiagrams', 'sp_renamediagram', 'sp_upgraddiagrams' and 'fn_diagramobjects'.

  • Email addresses report page now says "In page" rather than "Called from".

  • Form text area value extraction has been improved.

  • Help file updated, including the addition of more SQL Server connection strings.

  • Added FAQ entry in help relating to the KTML browser-based WYSIWYG HTML editor's ktml.js file.

  • VBScript ASP pages containing client-side JavaScript linked to external URLs are no longer identified as being written in JScript.

Download the ASP Documentation Tool Evaluation VersionASP Documentation Tool Trial Version

Monday, 29 October 2007

SQL Documentation Tool 7.1

The SQL Documentation Tool is a complete documentation solution for Microsoft SQL Server databases. It automatically creates comprehensive technical documentation reports for databases, saving valuable developer time and money.

Reports are created in HTML [sample], Microsoft's HTML Help [sample], RTF [sample] and text [sample] formats. Color coded, syntax highlighted copies of the Transact SQL associated with stored procedures, functions and views are included with the reports. The compiled HTML Help reports includes an index and search facility.

Version 7.1 offers the following update:

  • In response to user demand, the SQL Documentation Tool now has options to specify what should be documented in a project. It is now possible to document all/some or none of the following: tables, views, stored procedures, triggers, full-text catalogs, indexes, jobs and DTS packages.

Download the SQL Documentation Tool Evaluation VersionSQL Documentation Tool Trial Version

Monday, 8 October 2007

Documenting VB.NET source code with XML Comments

Posted new article about how to document Visual Basic.NET source code using Microsoft's XML Comments. The article contains code samples and a full XML comment reference guide.

Read the article at: http://www.softwaredocumentation.info/DocumentingVBNet.aspx

Documenting C# source code with XML Comments

Posted new article about how to document C# source code using Microsoft's XML Comments. The article contains code samples and a full XML comment reference guide.

Read the article at: http://www.softwaredocumentation.info/DocumentingCSharp.aspx

Wednesday, 3 October 2007

How to write good software documentation

Posted new article about how to write good quality software documentation. This article contains guidelines for producing high quality software documentation.

Read the article at: http://www.softwaredocumentation.info/DocumentingSoftware.aspx

Tuesday, 2 October 2007

ASP Documentation Tool 7.0

The ASP Documentation Tool™ creates comprehensive technical documentation for ASP web applications written in either VBScript or JScript.
Any Microsoft SQL Server, Microsoft Access databases and Visual Basic 6.0 COM objects associated with the application can also be documented if required.

Reports are created in HTML [sample], Microsoft's HTML Help [sample] and text [sample] formats. Color coded, syntax highlighted copies of the ASP, SQL and VB code are included with the reports. The compiled HTML Help reports include fully searchable source code, making the
ASP Documentation Tool™ an invaluable utility in understanding your (or someone
else's!) ASP web applications. A version for ASP.NET is also available.

Changes in version 7.0 are:


  • Improved logging of the FindMultiLineArgs routine and improved the detection of functions by this routine.

  • Visual Basic COM object source code is now HTML encoded.

  • Fix issue whereby database table columns were not being detected if there was a problem extracting details of triggers.
  • .
Download the ASP Documentation Tool Evaluation VersionASP Documentation Tool Trial Version

Thursday, 27 September 2007

SQL Documentation Tool 7.0

The SQL Documentation Tool is a complete documentation solution for Microsoft SQL Server databases. It automatically creates comprehensive technical documentation reports for databases, saving valuable developer time and money.

Reports are created in HTML [sample], Microsoft's HTML Help [sample], RTF [sample] and text [sample] formats. Color coded, syntax highlighted copies of the Transact SQL associated with stored procedures, functions and views are included with the reports. The compiled HTML Help reports includes an index and search facility.

Version 7.0 offers the following updates:

  • Changed the way stored procedure field lengths are reported. Lengths are now reported only for fields of type char, nchar, varchar, nvarchar and varbinary. nchar and nvarchar field lengths are reported in terms of the amount of characters that can be stored within them.

  • Stored procedure column types (e.g. input, output etc.) are now included in the report.

  • GUI buttons now disabled while data being extracted or project being documented.

  • It is now possible to specify an HTML report colour scheme.

  • Added tooltips to the Project options Window.

  • The project options now include the ability to include a user-specified HTML snippet within the HEAD element of the pages produced by the SQL Documentation Tool. This makes it possible to add a custom Cascading Style Sheet (CSS) to format the HTML report's output.

Download the SQL Documentation Tool Evaluation VersionSQL Documentation Tool Trial Version

Tuesday, 25 September 2007

ASP Documentation Tool 6.9

The ASP Documentation Tool™ creates comprehensive technical documentation for ASP web applications written in either VBScript or JScript. Any Microsoft SQL Server, Microsoft Access databases and Visual Basic 6.0 COM objects associated with the application can also be documented if required.

Reports are created in HTML [sample], Microsoft's HTML Help [sample] and text [sample] formats. Color coded, syntax highlighted copies of the ASP, SQL and VB code are included with the reports. The compiled HTML Help reports include fully searchable source code, making the
ASP Documentation Tool™ an invaluable utility in understanding your (or someone else's!) ASP web applications. A version of the documentor for .NET is also available.

Changes in version 6.9 are:


  • Visual Basic component source code now correctly saved. This corrects a problem introduced with version 6.7.

  • Guess stored procedure calls option now detects stored procedure calls prefixed with a username, e.g. dbo.FindProducts.

Download the ASP Documentation Tool Evaluation VersionASP Documentation Tool Trial Version

Monday, 17 September 2007

ASP Documentation Tool 6.8

The ASP Documentation Tool™ automatically creates technical documentation for ASP web applications written in either VBScript or JScript. Any Microsoft SQL Server, Microsoft Access databases and Visual Basic 6.0 COM objects associated with the application can also be documented if required.

Reports are created in HTML [sample], Microsoft's HTML Help [sample] and text [sample] formats. Color coded, syntax highlighted copies of the ASP, JavaScript, SQL and VB code are included with the reports. The compiled HTML Help reports include fully searchable source code, making the ASP Documentation Tool™ an invaluable utility in understanding your (or someone else's!) ASP web applications. A version for ASP.NET is also available.

Changes in version 6.8 are:


  • The sample project has been updated.

Download the ASP Documentation Tool Evaluation VersionASP Documentation Tool Trial Version

Thursday, 13 September 2007

Software Documentation Portal Launched

Our software documentation portal, http://www.softwaredocumentation.info/ has now been launched. The website contains links to high quality resources associated with the documentation of software. All links are manually reviewed to ensure only the best information is listed.

The portal has two main areas of focus: technical writing resources and software documentation tools. Technical writers are professionals who design, create, maintain and update technical documentation, online help, user guides, white papers, design specifications, and other documents.

Software documentation tools can be used to assist with the production of technical documentation. End user documentation shows how to use an application. End user documentation tools can automate some or all of the often laborious tasks associated with creating an application's documentation, saving time and money. By comparison, source code documentation tools assist with the creation of an application's technical documentation.

Want to get your technical writing resource listed on the website? Send us your details using the submit a resource page, and if deemed appropriate to the we'll add it to the site as soon as possible.

Monday, 10 September 2007

Index Server Companion 3.3

The Index Server Companion is a web crawler utility that allows Microsoft Index Server/Indexing Services to index content from remote websites (including those running Apache on Linux/Unix) and ODBC databases.

Version 3.3 offers the following updates:

  • It is now possible to crawl websites that use Windows NTLM authentication.
  • The documentation has been updated.

Monday, 3 September 2007

.NET Documentation Tool 8.2

The .NET Documentation Tool creates comprehensive technical software documentation for .NET Framework applications written in VB.NET or C#. Microsoft SQL Server and Microsoft Access databases associated with the application may also be documented if required. There is enhanced functionality for documenting ASP.NET web applications.

Reports are created in HTML [sample], Microsoft's HTML Help [sample] and text [sample] formats. Color coded, syntax highlighted copies of the .NET and SQL code are included with the reports. The compiled HTML Help reports include fully searchable source code, making the
.NET Documentation Tool an invaluable utility in understanding your (or someone
else's!) applications. Versions for ASP and Visual Basic 6.0 are also available.

Changes in version 8.2 of the .NET Documentation Tool are:

  • C# Properties are now detected and documented.

  • .NET Framework 2.0 generic classes are now recognised.

  • Improved table spacing within function and subroutine details pages, making argument's XML comments easier to read.

  • List of constructors now correctly points to appropriate VB.NET or C# constructors list page.

Download the .NET Documentation Tool Evaluation Version.NET Documentation Tool Trial Version

Tuesday, 28 August 2007

ASP Documentation Tool 6.7

The ASP Documentation Tool™ automatically creates comprehensive project documentation for ASP web applications written in either VBScript or JScript. Any Microsoft SQL Server, Microsoft Access databases and Visual Basic 6.0 COM objects associated with the application can also be documented if required.

Reports are created in HTML [sample], Microsoft's HTML Help [sample] and text [sample] formats. Color coded, syntax highlighted copies of the ASP, SQL and VB code are included with the reports. The compiled HTML Help reports include fully searchable source code, making the
ASP Documentation Tool™ an invaluable utility in understanding your (or someone
else's!) ASP web applications. A version for ASP.NET is also available.

Changes in version 6.7 are:
  • Modifications made to allow source code files from Apple Macintosh systems to be correctly parsed (useful if you receive files from Mac using web designers!).

Download the ASP Documentation Tool Evaluation VersionASP Documentation Tool Trial Version

Thursday, 16 August 2007

ASP Documentation Tool 6.6

The ASP Documentation Tool™ automatically creates comprehensive project documentation for ASP web applications written in either VBScript or JScript. Any Microsoft SQL Server, Microsoft Access databases and Visual Basic 6.0 COM objects associated with the application can also be documented if required.

Reports are created in HTML [sample], Microsoft's HTML Help [sample] and text [sample] formats. Color coded, syntax highlighted copies of the ASP, SQL and VB code are included with the reports. The compiled HTML Help reports include fully searchable source code, making the ASP Documentation Tool™ an invaluable utility in understanding your (or someone else's!) ASP web applications. A version for ASP.NET is also available.

Changes in version 6.6 are:

  • The Extras report is now optional - there is a checkbox to toggle the report in the GUI, or it may be turned off using the --e command line switch.

  • Added new [FINDING FILES] section to log file to show which files have been detected.

  • Cascading Style Sheets (CSS) are now included in a project's documentation if the project contains CSS files.

  • Add --e command line option and GUI command to help.
Download the ASP Documentation Tool Evaluation VersionASP Documentation Tool Trial Version

Monday, 13 August 2007

VB Documentation Tool 1.1

The VB Documentation Tool automatically creates comprehensive project documentation for Visual Basic 6.0 projects and their associated SQL Server or Microsoft Access databases.

Reports are created in HTML [sample], Microsoft's HTML Help [sample] and text [sample] formats. Color coded, syntax highlighted copies of the Visual Basic source code is included with the reports. The compiled HTML Help reports include fully searchable source code, making the VB Documentation Tool an invaluable utility in understanding your (or someone else's!) Visual Basic 6.0 web applications.

Version 1.1 has the following enhancements:

  • Functions and subroutines are now listed in the HTML Help index.
  • Projects and project groups are now also listed in the HTML Help index.
  • The start up project within a project group is now identified.
  • Evaluation version GUI automatically loads sample project.

Index Server Companion 3.2

The Index Server Companion is a web crawler utility that allows Microsoft Index Server/Indexing Services to index content from remote websites (including those running Apache on Linux/Unix) and ODBC databases. Version 3.2 offers the following update:
  • It is now possible to crawl SSL (https) websites with the Index Server Companion.

SSL support should work immediately if you are using the compiled version (i.e. IndexServerCompanion.exe). If, however, you are using the IndexServerCompanion.pl Perl script, then you will need to ensure that the Net_SSLeay.pm and IO-Socket-SSL modules are installed.

To do this for ActiveState's ActivePerl, do the following:

Open a command prompt and type the following:

Note that if you are using ActiveState's ActivePerl 5.8.x the URL in the instructions above should be set to http://theoryx5.uwinnipeg.ca/ppms instead. Type perl- v at the command prompt to find the version you are using.

If both Net_SSLeay.pm and IO-Socket-SSL modules install properly then you should be able to access SSL sites using the IndexServerCompanion.pl Perl script.

Wednesday, 11 July 2007

VB Documentation Tool 1.0

The VB Documentation Tool automatically creates comprehensive project documentation for Visual Basic 6.0 projects and their associated SQL Server or Microsoft Access databases.

Reports are created in HTML [sample], Microsoft's HTML Help [sample] and text [sample] formats. Color coded, syntax highlighted copies of the Visual Basic source code is included with the reports. The compiled HTML Help reports include fully searchable source code, making the VB Documentation Tool an invaluable utility in understanding your (or someone else's!) Visual Basic 6.0 web applications.

Wednesday, 27 June 2007

Problems viewing HTML Help files (.chm)

Microsoft have made changes in Windows XP Service Pack 2 and also Internet Explorer 7.0 that may affect your ability to view compiled HTML Help .chm files and HTML output from our range of software code documentation tools.

You may also have problems viewing such content if it is stored on a remote drive and accessed via a UNC share. To resolve the issue, copy the content to your computer's own disk (e.g. the C: drive) before viewing it.
See these links for alternative strategies for resolving the issue:


Unblocking .chm files

Some .chm files you download from a website are blocked by default.

To unblock them, run Windows Explorer, right-click on the CHM file, and select Properties from the popup menu. Click on the Unblock button immediately below the Advanced button on the General page. Click Apply to show the content. Once the CHM file has been unblocked, the Unblock button disappears.

.NET Documentation Tool 8.1

The .NET Documentation Tool automatically creates comprehensive project documentation for .NET and ASP.NET applications written in either C# or VB.NET. Changes in version 8.1 are:
  • Enumerators now listed in page details pages.
  • Enumerators now listed in class details pages.
  • More code added to sample project.
  • Improved detection of VB.NET enumerators.

Wednesday, 6 June 2007

ASP Documentation Tool 6.5

The ASP Documentation Tool automatically creates comprehensive project documentation for ASP web applications written in either VBScript or JScript. Changes in version 6.5 are:
  • ASP Cookie usage is now reported: Request.Coookies and Response.Cookies are both supported.
  • Client-Side JavaScript Cookie Usage is now shown in the HTML report (this assumes the use of the JavaScript document.cookies statement).

See the ASP Documentation Tool website for documentation samples and a downloadable trial version.

.NET Documentation Tool 8.0

The .NET Documentation Tool automatically creates comprehensive project documentation for .NET and ASP.NET applications written in either C# or VB.NET. Changes in version 8.0 are:

  • VB.NET Properties are now documented.
  • Improved the detection of VB.NET functions and subroutines.
  • The Value XML Comment tag is now supported (it is used to document Properties).
  • XML Comment detection has been improved.

Thursday, 12 April 2007

ASP Documentation Tool 6.4

The ASP Documentation Tool automatically creates comprehensive project documentation for ASP web applications written in either VBScript or JScript. Changes in version 6.4 are:
  • Resolved an issue whereby ASP code within client-side JavaScript was inflating the line count report.
  • If the output folder does not exist the ASP Documentation Tool will attempt to create it.
  • Add new version of SampleWeb/Default.asp and ServerVariables.asp
  • Report now shows if an ASP page uses the Option Explicit statement.

.NET Documentation Tool 7.9

The .NET Documentation Tool automatically creates comprehensive project documentation for .NET and ASP.NET applications written in either C# or VB.NET. Changes in version 7.9 are:

  • Stopped files in App_Code folders being detected multiple times.
  • Detection of component files has been improved.
  • In response to user requests, it is now possible to add a copyright string to pages within the documentation (this feature is not customisable in the evaluation version).
  • Improved the colour coding of XML files.
  • Improved the detection of VB.NET functions.
  • Javascript Pages heading now omitted from documentation if there are no JavaScript files in the project.

Index Server Companion 3.1

The Index Server Companion is a web crawler utility that allows Microsoft Index Server/Indexing Services to index content from remote websites (including those running Apache on Linux/Unix) and ODBC databases. Version 3.1 offers the following updates:
  • Modified the database data extraction routine in order to ensure that fields of type adDBDate are extracted in date format and adDBTime are extracted in time format.
  • Modified the database data extraction routine in order to ensure that date and time fields are not converted to date/time format if the field has a null value.

SQL Documentation Tool 6.9.1

The SQL Documentation Tool creates comprehensive technical documentation reports for Microsoft SQL Server databases. Version 6.9.1 offers the following updates:
  • Changed the way data field lengths are reported. Lengths are now reported only for fields of type char, nchar, varchar, nvarchar and varbinary.
  • nchar and nvarchar field lengths are reported in terms of the amount of characters that can be stored within them.
  • Improved error handling when buttons are pressed in GUI without items being selected first.
  • Improved error handling in DataStore accessing class.
  • More buy now buttons added to sample output in evaluation version.
  • Increased size of buy now button in evaluation version.
  • Decreased the connection timeout time, making it easier to know if the SQL Server connectivity has not been correctly established.
  • Database specific content data extraction routine now reports correct msdb database name.

Index Server Companion 3.0

The Index Server Companion is a web crawler utility that allows Microsoft Index Server/Indexing Services to index content from remote websites (including those running Apache on Linux/Unix) and ODBC databases. Version 3.0 offers the following update:
  • Modified the database data extraction routine in order to ensure that fields of type adDate are extracted in date format.

Wednesday, 21 March 2007

SQL Documentation Tool 6.8

The SQL Documentation Tool creates comprehensive technical documentation reports for Microsoft SQL Server databases. Version 6.8 offers the following updates:
  • There is now an error reporting text box on the GUI. Brief details of errors are now added to this text box. Note that not all errors are serious, for example the SQL Documentation Tool will show full text index errors if the SQL Server does not have full text indexing available or configured, and SQL Server 2005 Express Edition does not support either DTS packages or Job schedules.
  • The SQL Documentation Tool will now document databases named using reserved words or other non-recommended naming (e.g. spaces or underscores).
  • Full application errors are now added to the log file.
  • The error trapping routines have been greatly improved detailed error messages are appended to the project's log file. Note that not all errors are serious, for example the SQL Documentation Tool will show full text index errors if the SQL Server does not have full text indexing available or configured, and SQL Server 2005 Express Edition does not support either DTS packages or Job schedules.
  • Fixed a small issue with the logging of SQL Server Job names to the log file.

Index Server Companion 2.9

The Index Server Companion is a web crawler utility that allows Microsoft Index Server/Indexing Services to index content from remote websites (including those running Apache on Linux/Unix) and ODBC databases. Version 2.9 offers the following updates:
  • The AddURLToTitle configuration option has improved support for HTML documents with blank title tags.
  • There is now a .NET Framework code sample for VB.NET. Find it in the Samples\Index Server with ASP.NET\ASP.NET\VB.NET folder within the Index Server Companion folder.

ASP Documentation Tool 6.3

The ASP Documentation Tool automatically creates comprehensive project documentation for ASP web applications written in either VBScript or JScript. Changes in version 6.3 are:
  • There are two new reports available from the Extras section. The Code Comments Report (VBScript) report shows the approximate amount of commented out VBScript code within each ASP file. The Code Comments Report (JScript) report shows the approximate amount of commented out JScript code within each ASP file. These reports can assist with code tidying and rationalisation projects. They can also help identify pages that need commenting.

See the ASP Documentation Tool website for documentation samples and a downloadable trial version.

SQL Documentation Tool 6.6

The SQL Documentation Tool creates comprehensive technical documentation reports for Microsoft SQL Server databases. Version 6.6 offers the following updates:
  • Corrected a problem with the display of View columns in the documentation.
  • Removed system views "sysconstraints" and "syssegments" from database documentation.
  • Corrected an issue with the use of custom connection strings.

SQL Documentation Tool 6.7

The SQL Documentation Tool creates comprehensive technical documentation reports for Microsoft SQL Server databases. Version 6.7 offers the following updates:
  • Product now fully integrated with RegNow's affiliate marketing system.
  • Added more buy now links to the evaluation version and removed some of the pop-up Window registration reminders.
  • Logs folder is now created if it does not already exist.

Friday, 23 February 2007

SQL Documentation Tool 6.5

The SQL Documentation Tool creates comprehensive technical documentation reports for Microsoft SQL Server databases. Version 6.5 offers the following updates:

  • Added a Connection String field to the Connection properties window - this will allow a custom connection string to be specified. Note that a custom connection string must be specified for SQL Server 2005 - see the documentation for more information or try http://www.connectionstrings.com/.
  • Stopped system views appearing in documentation output.
  • The project "use table column descriptions" option is now correctly checked/unchecked.
    Fixed a minor status error in the database documentation routine.

Index Server Companion 2.8

The Index Server Companion is a web crawler utility that allows Microsoft Index Server/Indexing Services to index content from remote websites (including those running Apache on Linux/Unix) and ODBC databases. Version 2.8 offers the following update:
  • The AddURLToTitle configuration option has improved support for HTML documents with blank title tags (i.e. <title></title>).

Monday, 19 February 2007

.NET Documentation Tool 7.8 Changes

The .NET Documentation Tool creates comprehensive technical documentation for .NET and ASP.NET projects written in either C# or VB.NET. Forthcoming changes in version 7.8 of the .NET Documentation Tool:
  • The XML Comment parsing routine has been rewritten, allowing more tags to be supported in this and subsequent versions of the .NET Documentation Tool. See Recommended XML Tags for Documentation Comments for details of the tags that can be used to document .NET source code with the XML commenting system.
  • The XML Comment exception, paramref, see and seealso tags are now fully supported in both C# and VB.NET source code.
  • The XML Comment list tag is now supported. This tag allows bulleted or numbered lists as well as tables to be incorporated into the XML Comment documentation produced by the .NET Documentation Tool.
  • Subroutine argument XML Comments are now extracted from source code.
  • The HTML output for a project's functions and subroutines has been improved.

.NET Documentation Tool 7.7 Changes

The .NET Documentation Tool creates comprehensive technical documentation for .NET projects written in either C# or VB.NET. Forthcoming changes in version 7.7 of the .NET Documentation Tool:

  • XML Comments in Visual Studio 2005 format are now optionally extracted from VB.NET code (the .NET Documentation Tool has supported C# XML Comments in prior versions). See the section Documenting Your Code with XML (Visual Basic) in the Visual Studio 2005 documentation for information on using these comments in your own VB.NET code.
  • Code behind files with spaces in the filenames are now correctly identified.
  • / weird characters are now removed from source code files, improving the rendering of output of some source code files.

Friday, 16 February 2007

XML Comments in VB.NET

Woohoo!

With the introduction of Visual Studio 2005, Microsoft have added the XML Comments system to VB.NET, so it is now possible to fully document VB.NET source code using the XML Comments technique that was previously only possible to utilise in C#. Thank you Microsoft!

Version 8.0 of the .NET Documentation Tool will support XML Comments in VB.NET as well as C#. This makes it possible to produce much higher quality documentation for VB.NET, so start adding XML Comments to your VB.NET code today!

P.S. If you're using Visual Studio 2005 it's easy - just type three single quotes above a class, function or property declaration and Visual Studio will automagically create an XML Comment template for you to complete.

XML Comments are also used by the Intellisense autocomplete system, so they're well worth using!

Welcome!

Welcome to the documentation tools blog. This blog will be used to post news about our code documentation tools and other product offerings.

See http://www.winnershtriangle.com/w/Products.Main.asp for our full list of products.