XmlCommentsFile Class

This represents an XML comment file and is used when searching for and adding missing documentation tag information.

Definition

Namespace: Sandcastle.Core.BuildEngine
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2025.9.30.0

public class XmlCommentsFile

Public Class XmlCommentsFile

public ref class XmlCommentsFile

type XmlCommentsFile = class end

Constructor

Comments	This is used to load the comments file on first use
Encoding	This read-only property is used to get the encoding, typically UTF-8
InvalidReason	If IsValid returns false, this returns the reason that the XML comments file is invalid
IsValid	This read-only property indicates whether or not the comments file contains valid, well-formed XML
Members	This read-only property is used to get the root members node
SourcePath	This read-only property is used to get the source path of the file

Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
ForceReload	This can be used to force a reload of the comments file if changes were made to it outside of this instance.
GetHashCode	Serves as the default hash function. (Inherited from Object)
GetType	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
Save	Save the comments file if it was modified
ToString	Returns a string that represents the current object. (Inherited from Object)