This documentation is also published as Markdown for efficient machine reading: the whole site is indexed at /llms.txt, and every page has a clean Markdown copy under /_llms/. These are generated from the same source and cost far fewer tokens to read than this rendered HTML.

Skip to main content Skip to navigation

ApiTypeDetail Pennington.ApiMetadata

Full detail for a documented type, including parsed xmldoc and inheritance data, but not its members (those stream from GetMembersAsync).

Properties

Implements ImmutableArray<string>
Implemented-interface uids.
Inheritance ImmutableArray<string>
Base-type uids, most-derived first. Empty for interfaces and object.
SignatureHtml string
Pre-highlighted declaration HTML, or null when not available.
Summary ApiTypeSummary
Header describing the type.
Xmldoc ParsedXmlDoc
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

Summary ApiTypeSummary
Header describing the type.
Xmldoc ParsedXmlDoc
Parsed xmldoc for the type itself.
SignatureHtml string
Pre-highlighted declaration HTML, or null when not available.
Inheritance ImmutableArray<string>
Base-type uids, most-derived first. Empty for interfaces and object.
Implements ImmutableArray<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; }
}