Sandcastle Help File Builder Documentation
SandcastleBuilder.Utils Namespaces
SandcastleBuilder.Utils
SandcastleProject Class
SandcastleProject Properties
ApiFilter Property
AutoDocumentConstructors Property
AutoDocumentDisposeMethods Property
BasePath Property
BinaryTOC Property
BuildAssemblerVerbosity Property
BuildLogFile Property
CatalogName Property
CatalogProductId Property
CatalogVersion Property
CleanIntermediates Property
CollectionTocStyle Property
ComponentConfigurations Property
ComponentPath Property
Configuration Property
ContentPlacement Property
CopyrightHref Property
CopyrightText Property
CppCommentsFixup Property
DecodedCopyrightText Property
DisableCodeBlockComponent Property
DocumentationSources Property
DocumentAttributes Property
DocumentExplicitInterfaceImplementations Property
DocumentInheritedFrameworkInternalMembers Property
DocumentInheritedFrameworkMembers Property
DocumentInheritedFrameworkPrivateMembers Property
DocumentInheritedMembers Property
DocumentInternals Property
DocumentNoPIATypes Property
DocumentPrivateFields Property
DocumentPrivates Property
DocumentProtected Property
DocumentProtectedInternalAsProtected Property
DocumentSealedProtected Property
FeedbackEMailAddress Property
FeedbackEMailLinkText Property
FileItems Property
Filename Property
FooterText Property
FrameworkVersion Property
HeaderText Property
HelpAttributes Property
HelpFileFormat Property
HelpFileVersion Property
HelpTitle Property
HtmlHelp1xCompilerPath Property
HtmlHelp2xCompilerPath Property
HtmlHelpName Property
HtmlSdkLinkType Property
IncludeFavorites Property
IncludeStopWordList Property
IndentHtml Property
IsDirty Property
KeepLogFile Property
Language Property
LogFileLocation Property
MaximumGroupParts Property
MissingTags Property
MSBuildOutDir Property
MSBuildProject Property
MSHelp2SdkLinkType Property
MSHelpViewerSdkLinkType Property
NamespaceGrouping Property
NamespaceSummaries Property
NamingMethod Property
OutputPath Property
Platform Property
PlugInConfigurations Property
PlugInNamespaces Property
Preliminary Property
PresentationStyle Property
ProductTitle Property
ProjectSummary Property
References Property
RootNamespaceContainer Property
RootNamespaceTitle Property
SdkLinkTarget Property
ShowMissingIncludeTargets Property
ShowMissingNamespaces Property
ShowMissingParams Property
ShowMissingRemarks Property
ShowMissingReturns Property
ShowMissingSummaries Property
ShowMissingTypeParams Property
ShowMissingValues Property
SyntaxFilters Property
TocOrder Property
TocParentId Property
TocParentVersion Property
TopicVersion Property
TransformComponentArguments Property
UsingFinalValues Property
VendorName Property
VisibleItems Property
WebsiteSdkLinkType Property
WorkingPath Property
Click or drag to resize
Sandcastle Help File BuilderSandcastleProjectAutoDocumentDisposeMethods Property
This is used to get or set whether or not dispose methods are automatically documented if they are missing the <summary> tag and for classes with compiler generated dispose methods.

Namespace: SandcastleBuilder.Utils
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2014.11.22.0
Syntax
Copy
public bool AutoDocumentDisposeMethods { get; set; }

Property Value

Type: Boolean
Set this to true to automatically add default text for the <summary> tag on dispose methods that are missing it and for classes with compiler generated dispose methods. If set to false and ShowMissingSummaries is true, a "missing summary" warning will appear instead. A message is also written to the log file. If a Dispose(Boolean) method is present, its parameter will also be auto-documented if necessary. If set to false and ShowMissingParams is true, a "missing parameter" message will appear instead.
See Also