GhostDoc Enterprise - Command Line Parameters

The Enterprise edition of GhostDoc includes command line utility that enables continuous integration to generate help documentation as part of the build process.

If you don't have GhostDoc Enterprise installed, you can download the free 14 day evaluation copy here.

The GhostDoc Enterprise command line is quite straightforward to use. Here is a quick reference:

/solution  [/s]
solution file to load (*.sln file)

/helpConfiguration  [/h]
help configuration to use

/projectConfiguration  [/c]
project configuration

/consoleDetailed  [/d]
show detailed console output (brief is default)

/quiet [/q]
hide console output

Where:

helpConfiguration - is the configuration you save in the Build Help File dialog

projectConfiguration - is your VS project/build configuration - Debug, Release or your custom config.

Example 1:

Help documentation generated using the "HelpFile" configuration

SubMain.GhostDoc.Cmd.exe /solution:"Sample.sln" /helpConfiguration:"HelpFile" /projectconfiguration:"Debug" 


Example 2:

Help documentation generated using the custom help configuration "Website" with detailed console output

SubMain.GhostDoc.Cmd.exe /solution:"Sample.sln" /helpConfiguration:"Website" /projectconfiguration:"Debug" /consoledetailed

Add Feedback