Record
public record XmlDocFile : System.IEquatable<Moka.Docs.CSharp.XmlDoc.XmlDocFile>Namespace: Moka.Docs.CSharp.XmlDoc
Represents a parsed XML documentation file.
Inheritance
Implements: System.IEquatable<Moka.Docs.CSharp.XmlDoc.XmlDocFile>
Properties
| Name | Description |
|---|---|
AssemblyName |
The assembly name from the XML doc file. |
Empty static |
An empty doc file. |
Members |
All member documentation entries, keyed by member ID string. |
AssemblyName
string XmlDocFile.AssemblyName { get; init; }The assembly name from the XML doc file.
Empty
XmlDocFile XmlDocFile.Empty { get; }An empty doc file.
Members
Dictionary<string, XmlDocBlock> XmlDocFile.Members { get; init; }All member documentation entries, keyed by member ID string.
Methods
| Name | Description |
|---|---|
GetMemberDoc(string memberId) |
Gets the documentation for a member by its ID string. |
GetMemberDoc(string memberId)
XmlDocBlock? XmlDocFile.GetMemberDoc(string memberId)Gets the documentation for a member by its ID string.
Type Relationships
classDiagram
style XmlDocFile fill:#f9f,stroke:#333,stroke-width:2px
XmlDocFile ..|> XmlDocFile~ : implements
View Source
/// <summary>
/// Represents a parsed XML documentation file.
/// </summary>
public sealed record XmlDocFile
{
/// <summary>The assembly name from the XML doc file.</summary>
public string AssemblyName { get; init; } = "";
/// <summary>All member documentation entries, keyed by member ID string.</summary>
public Dictionary<string, XmlDocBlock> Members { get; init; } = [];
/// <summary>An empty doc file.</summary>
public static XmlDocFile Empty => new();
/// <summary>
/// Gets the documentation for a member by its ID string.
/// </summary>
public XmlDocBlock? GetMemberDoc(string memberId) => Members.GetValueOrDefault(memberId);
}