XmlCommentsFile Class
Definition
- Namespace
- Sandcastle.Core.BuildEngine
- Assembly
- Sandcastle.Core.dll
This represents an XML comment file and is used when searching for and adding missing documentation tag information.
public class XmlCommentsFile- Inheritance
-
XmlCommentsFile
Constructors
| XmlCommentsFile(string) |
Constructor |
Properties
| 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 |
Methods
| ForceReload() |
This can be used to force a reload of the comments file if changes were made to it outside of this instance. |
| Save() |
Save the comments file if it was modified |