GhostDoc Help Documentation Builder Task

Overview

This extension will add a Build/Release task in your DevOps instance that will allow you to produce code help documentation. The task ships with the necessary GhostDoc assemblies and files.

Requirements

You need to be a licensed user of GhostDoc Enterprise and have a dedicated user license for the build server for this task to run.

The different parameters of the task are explained below:

• Solution: Name of the solution to load (the *.sln file).
• Help Configuration: The help configuration saved in the Build Help Documentation dialog.
• Project Configuration: Visual Studio project build configuration - Debug, Release or custom.
• License: The GhostDoc Enterprise license you purchased for the build server.
• Detailed console output: Turns on detailed console output (default is Brief).
• Cleanup: Remove all files and folders in the help output directory.

Task post processing

You will need to add a new task to copy the generated help documentation from your target folder.