...
NDoc modes
Use NDoc project file
The NDoc project file that defines which assemblies should be processed.
Specify assemblies
A list of assemblies to document. No assemblies outside of this list will be documented. Good for documentation generation that will be very unlikely to change over time.
Search for assemblies
The location to start searching for assemblies to document. The Maximum depth option determines how many folders deep the searching will go.
Options
Verbose output
All progress and status messages generated from NDoc will be written to the FinalBuilder log. This can slow down the action, yet does provide substantial information for debugging purposes.
Namespace summaries file
NDoc version
1.2
1.3
Documenter
Documenter
A file which defines the summary descriptions for namespaces. Helpful for improving readability of output from NDoc and the documentation it generates. The file takes the format of;
Code Block | ||
---|---|---|
| ||
<namespaces>
<namespace name="My.NameSpace">My summary.</namespace>
<namespace name="My.OtherNameSpace">My other summary.</namespace>
...
</namespaces> |
NDoc version
The version of NDoc to use in the action. The locations of NDoc executables are defined in the options for FinalBuilder.
Documenter
Documenter
The name of the documenter to use if not specified, the MSDN documenter will be used.