NDoc 1.3.1 SDK

IDocumenter.CanBuild Method (Project, Boolean)

Checks to make sure the documenter can perform a build.

[Visual Basic]
Function CanBuild( _ 
   ByVal project As Project, _ 
   ByVal checkInputOnly As Boolean _ 
) As String
[C#]
string CanBuild(
   Project project,
   bool checkInputOnly
);
[C++]
String* CanBuild(
   Project* project,
   bool checkInputOnly
);
[JScript]
function CanBuild(
   Project project,
   bool checkInputOnly
): String;

Parameters

project
The project that would be built.
checkInputOnly
When true, don't check for output file locking.

Return Value

null if the documenter can build; otherwise a message describing why it can't build

Remarks

This is for people who like to leave their CHMs open.

See Also

IDocumenter Interface | NDoc.Core Namespace | IDocumenter.CanBuild Overload List