Click or drag to resize
Sandcastle Help File BuilderXmlCommentsFile 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

The XmlCommentsFile type exposes the following members.

Constructors
  NameDescription
Public methodXmlCommentsFile
Constructor
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFixupComments
This is called to fix-up the comments for C++ compiler generated XML comments files.
Public methodForceReload
This can be used to force a reload of the comments file if changes were made to it outside of this instance.
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodSave
Save the comments file if it was modified
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Properties
  NameDescription
Public propertyComments
This is used to load the comments file on first use
Public propertyEncoding
This read-only property is used to get the encoding, typically UTF-8
Public propertyMembers
This read-only property is used to get the root members node
Public propertySourcePath
This read-only property is used to get the source path of the file
Top
See Also