Tips ...
Currently VBXC used the VS.NET extensibility model to parse most of the VB.NET code to generate the XML comment file, that means you have to use VS.NET to generate your XML comment file. But it can be done from the commandline in two different ways. There are plans for a standalone commandline util that can generate the XML comment file, but it's not planned in the 1.0 release.
Compiling solution and generating XML comments from the commandline
This approach compiles your solution and let's VBXC build the XML comment file for your projects. To use this approach write something like this in a commandline session where you have devenv.exe in your path.
devenv vbxmldoctestproj.sln /build release
You should get output that looks like this:
Microsoft (R) Development Environment Version 7.00.9466.
Copyright (C) Microsoft Corp 1984-2001. All rights reserved.
------ Build started: Project: VBXMLDocTestProj, Configuration: Release .NET ------
Preparing resources...
Updating references...
Performing main compilation...
Building satellite assemblies...
VBXC initiating ...
Version: Beta 3 (0.3.0.0)
Project information:
- Name: VBXMLDocTestProj.vbproj
- Platform: .NET
- Solution config: Debug
Warning: Missing comment for element VBXMLDocTestProj.MyEnum (element: VBXMLDocTestProj.MyEnum)
Generated XML Documentation for the project VBXMLDocTestProj.vbproj
The problem with this approach is if you don't want to have VS.NET installed on your build computer, and you also have to keep the solution and project files intact on your build computer.
Only generating XML comment file from the commandline
VBXC provides a command that builds the XML comment file and exits VS.NET as soon as the XML file is created. Using this approach you will se VS.NET opening for a few seconds before it closes itself. To use this approach write something like this in a commandline session where you have devenv.exe in your path.
devenv vbxmldoctestproj.sln /command VBXCAddin.Connect.VBXCAddinBuildXMLCommentsForSolutionAndExit
The problem with this approach is that any crashes makes VBXC open a dialog box with the error, and you have no way of telling
Tor-Erik Hagen © 2002-2003
