Using VSdocman from Command Line

VSdocman can be called from command line. However, you always need to configure your project settings in IDE. Before trying VSdocman from command line, test it from IDE first.

To compile documentation from command line, you need to call VSdocmanCmdLine.exe utility located in VSdocman installation folder.

Syntax

VSdocmanCmdLine.exe [/?] [/vs 2002 | 2003 | 2005 | 2008] [/operation compileProject |
                    compileSolution | compileSolutionToSingle]
                    [/profile "PROFILE_NAME"]
                    [/baseProject PROJECT_NAME] "PROJECT_OR_SOLUTION"

Command Line Parameters

Parameter	Description
PROJECT_OR_SOLUTION	The full absolute path to the project file (.csproj, .vbproj, ...) if the operation is compileProject. Otherwise it is full path to the solution file (.sln).
/vs	Version of Visual Studio which was used for editing specified project or solution. This version of VS must be installed. If this parameter is omitted, the latest installed version of VS will be used.
/operation	Operation to perform. There are three choices: compileProject - compiles single project compileSolution - compiles each project in solution into separate documentation. compileSolutionToSingle - compiles whole solution into single documentation
/profile	Profile name used. If the operation is compileProject, it must be project profile name. Otherwise it is solution profile name. The name must be enclosed in double quotes. If this parameter is omitted, "default" profile will be used.
/baseProject	Base project for compileSolutionToSingle operation. It is pure name of the base project, without extension (e.g. .vbproj) and without absolute path.
/?	Show help.

Exit Codes

Code	Description
0	OK
1	Visual Studio (version specified by /vs parameter) was not found.
2	Incorrect command line parameters.
3	Other error.

Examples

To compile documentation for whole solution to several documents, one for each project, in the latest VS version installed:

  VSdocmanCmdLine.exe /operation compileSolution /profile "My profile" "C:\SLN\solution.sln"

To compile documentation for whole solution to one resulting documentation, common settings will be taken from base project, the "default" profile will be used:

  VSdocmanCmdLine.exe /operation compileSolutionToSingle /baseProject MyBaseProject "C:\SLN\solution.sln"

To compile documentation for one project:

  VSdocmanCmdLine.exe /operation compileProject /profile "My project profile" "C:\SLN\PRJ\project.vbproj"