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

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

Syntax

VSdocmanCmdLine.exe [/?] [/vs 2012 | 2013 | 2015]

                    [/devenvPath "DEVENV_EXE_PATH"]

                    [/operation compileProject | compileSolution | compileSolutionToSingle]

                    [/profile "PROFILE_NAME"]

                    "PROJECT_OR_SOLUTION"

Command Line Parameters

Parameter

Description

PROJECT_OR_SOLUTION

A full absolute path to the project file (.csproj, .vbproj, ...) if the operation is compileProject. Otherwise it is a 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. This parameter is only valid for VS 2012, 2013 and 2015. For VS 2017 and newer, use the /devenvPath parameter.

/devenvPath

The full path to the devenv.exe to be used internally. If this argument is specified, the /vs is ignored. This parameter must be used with VS 2017 and higher,because there may be multiple instances of the same VS version installed. Note that when VS 2017 was installed after any other possible VS version on the computer, and the /vs parameter is omitted, VS 2017 will not be used automatically. You need to specify the /devenvPath parameter.

/operation

Operation to perform. There are three choices:

compileProject - compiles a single project

compileSolution - compiles each project in a solution into separate documentation.

compileSolutionToSingle - compiles entire solution into a single documentation. The settings from the solution-wide common properties, that were selected in the IDE the last time the "Compile Solution to Single Documentation" was executed, will be applied.

/profile

Profile name used. If the operation is compileProject, it must be a project profile name. Otherwise it is a solution profile name. The name must be enclosed in double quotes. If this parameter is omitted, the "default" profile will be used.

/retryOnCpuBusy

Specifies if the utility should retry when the operation fails due to a high CPU load. In very rare cases, it may happen that the utility exits with the error code 1 (Visual Studio was not found) with the additional exception info: COMException (0x80080005). This is usually caused by the current high CPU load. On the next execution everything works. This parameter specifies how many times and with what intervals in seconds should the utility retry automatically in such cases. The values are separated by a semicolon. If you encounter this problem, set the parameter to something like this:

/retryOnCpuBusy 3;60

/?

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