XmlCommentsFile Class

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

Inheritance Hierarchy

SystemObject
SandcastleBuilder.Utils.BuildEngineXmlCommentsFile

Namespace: SandcastleBuilder.Utils.BuildEngine
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2014.11.22.0

Syntax

public class XmlCommentsFile

Public Class XmlCommentsFile

public ref class XmlCommentsFile

type XmlCommentsFile =  class end

The XmlCommentsFile type exposes the following members.

Constructors

	Name	Description
	XmlCommentsFile	Constructor

Methods

	Name	Description
	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.)
	FixupComments	This is called to fix-up the comments for C++ compiler generated XML comments files.
	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 a hash function for a particular type. (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.)

Properties

	Name	Description
	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
	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