A Little delayed compared to my hopes, but I finally got the next version up.

Again, this is manually packaged.

The configuration remains mostly the same, a "buildCondition" has been added, this controls if the build fails or not on missing parts, however the logic for this is not yet implemented.

 

Node Description Type Required Default
projectFile A path to the project file to use for building the help files. string Yes None
publishPath A path to copy all output after build. string No None
executeable A path to the SandcastleBuilderConsole.exe file. string No <program files>\EWSoftware\Sandcastle Help File Builder\SandcastleBuilderConsole.exe
timeout The time-out period in seconds for the sandcastle help file builder, this does currently not include post processing and publishing. int No 180
baseDirectory Currently not in use string No None
buildCondition Currently not in use

Configured as a enumeration, several values may be included, e.g. "Type, Member", sets up what documentation parts is required.

Available Values:
 - None
 - Type
 - Member
 - Return
 - Param
 - Ctor		 string No "None"

From the list of requirements, the following are "implemented":

  • Build a Sandcastle Help File Builder project.
  • Copy the output to a desired directory.
  • Parse Sandcastle Help File Builder log to something that can be displayed in CCNet
  • Summary for the build (number of missing references, documentations)
  • Detailed report over missing documentations (Browse able by components ect.)  - Partly
  • Pass/Fail levels on missing documentation - Setup Only

Yet to be desired:

  • Pass/Fail levels on missing documentation - Full
  • Detailed report over missing documentations (Browse able by components ect.)  - Full

A List of required tools:

This plug-in is released under a LGPL license