ApiTypeDetail
Pennington.ApiMetadata
Full detail for a documented type, including parsed xmldoc and inheritance data, but not its members (those stream from GetMembersAsync).
Properties
ImplementsImmutableArray<string>- Implemented-interface uids.
InheritanceImmutableArray<string>- Base-type uids, most-derived first. Empty for interfaces and
object. SignatureHtmlstring- Pre-highlighted declaration HTML, or
nullwhen not available. SummaryApiTypeSummary- Header describing the type.
XmldocParsedXmlDoc- Parsed xmldoc for the type itself.
Constructors
ApiTypeDetail
#public ApiTypeDetail(ApiTypeSummary Summary, ParsedXmlDoc Xmldoc, string SignatureHtml, ImmutableArray<string> Inheritance, ImmutableArray<string> Implements)
Full detail for a documented type, including parsed xmldoc and inheritance data, but not its members (those stream from GetMembersAsync).
Parameters
SummaryApiTypeSummary- Header describing the type.
XmldocParsedXmlDoc- Parsed xmldoc for the type itself.
SignatureHtmlstring- Pre-highlighted declaration HTML, or
nullwhen not available. InheritanceImmutableArray<string>- Base-type uids, most-derived first. Empty for interfaces and
object. ImplementsImmutableArray<string>- Implemented-interface uids.
Pennington.ApiMetadata.ApiTypeDetail
namespace Pennington.ApiMetadata;
/// Full detail for a documented type, including parsed xmldoc and inheritance data, but not its members (those stream from GetMembersAsync).
public record ApiTypeDetail
{
/// Full detail for a documented type, including parsed xmldoc and inheritance data, but not its members (those stream from GetMembersAsync).
public ApiTypeDetail(ApiTypeSummary Summary, ParsedXmlDoc Xmldoc, string SignatureHtml, ImmutableArray<string> Inheritance, ImmutableArray<string> Implements)
;
/// Implemented-interface uids.
public ImmutableArray<string> Implements { get; set; }
/// Base-type uids, most-derived first. Empty for interfaces and object.
public ImmutableArray<string> Inheritance { get; set; }
/// Pre-highlighted declaration HTML, or null when not available.
public string SignatureHtml { get; set; }
/// Header describing the type.
public ApiTypeSummary Summary { get; set; }
/// Parsed xmldoc for the type itself.
public ParsedXmlDoc Xmldoc { get; set; }
}