ApiMember Pennington.ApiMetadata

Single member (property, field, method, constructor, or event) of a documented type, with all display strings pre-formatted by the backend provider.

Properties

DefaultValue string?: Default: null
Formatted default value literal, or null when none is declared.
HasInheritDocDirective bool: Default: false
Whether the source xmldoc carried an <inheritdoc/> directive; consumers use this to suppress "missing summary" diagnostics when inheritance didn't resolve.
InheritedFromName string?: Default: null
When the member is inherited, the short name of the declaring type for grouping headers (e.g. IContentEmitter). null for directly-declared members.
InheritedFromUid string?: Default: null
When the member is inherited from a base interface (rather than declared on the queried type), the xmldocid of the declaring type. null for directly-declared members.
IsRequired bool: Default: false
Whether the member carries the required modifier.
Kind Pennington.ApiMetadata.MemberKind: The kind of member this record represents.
Name string: Display name of the member (for methods, includes type-parameter list; for constructors, the containing type name).
Parameters System.Collections.Immutable.ImmutableArray<Pennington.ApiMetadata.ApiParameter>: Formatted parameter list for methods/constructors; empty for properties/fields/events.
ReturnTypeDisplay string?: Default: null
Formatted return type for methods that return a value; null otherwise.
SignatureHtml string?: Default: null
Pre-highlighted declaration HTML ready to inject with @((MarkupString)…), or null when no declaration signature is available.
TypeDisplay string: Human-readable type signature (return type for methods, declared type for properties/fields/events).
Uid string: Canonical xmldocid (e.g. M:Namespace.Type.Method(System.Int32)).
Xmldoc Pennington.ApiMetadata.ParsedXmlDoc: Parsed xmldoc for the member.

Constructors

.ctor

public sealed record ApiMember(
    string Uid,
    string Name,
    MemberKind Kind,
    string TypeDisplay,
    string? DefaultValue,
    bool IsRequired,
    bool HasInheritDocDirective,
    ParsedXmlDoc Xmldoc,
    string? SignatureHtml,
    ImmutableArray<ApiParameter> Parameters,
    string? ReturnTypeDisplay,
    string? InheritedFromUid = null,
    string? InheritedFromName = null);

Single member (property, field, method, constructor, or event) of a documented type, with all display strings pre-formatted by the backend provider.

Parameters

Uid string: Canonical xmldocid (e.g. M:Namespace.Type.Method(System.Int32)).
Name string: Display name of the member (for methods, includes type-parameter list; for constructors, the containing type name).
Kind MemberKind: The kind of member this record represents.
TypeDisplay string: Human-readable type signature (return type for methods, declared type for properties/fields/events).
DefaultValue string?: Formatted default value literal, or null when none is declared.
IsRequired bool: Whether the member carries the required modifier.
HasInheritDocDirective bool: Whether the source xmldoc carried an <inheritdoc/> directive; consumers use this to suppress "missing summary" diagnostics when inheritance didn't resolve.
Xmldoc ParsedXmlDoc: Parsed xmldoc for the member.
SignatureHtml string?: Pre-highlighted declaration HTML ready to inject with @((MarkupString)…), or null when no declaration signature is available.
Parameters ImmutableArray<ApiParameter>: Formatted parameter list for methods/constructors; empty for properties/fields/events.
ReturnTypeDisplay string?: Formatted return type for methods that return a value; null otherwise.
InheritedFromUid string? (optional): When the member is inherited from a base interface (rather than declared on the queried type), the xmldocid of the declaring type. null for directly-declared members.
InheritedFromName string? (optional): When the member is inherited, the short name of the declaring type for grouping headers (e.g. IContentEmitter). null for directly-declared members.

Pennington.ApiMetadata.ApiMember

namespace Pennington.ApiMetadata;

/// Single member (property, field, method, constructor, or event) of a documented type, with all display strings pre-formatted by the backend provider.
public record ApiMember
{
    /// Single member (property, field, method, constructor, or event) of a documented type, with all display strings pre-formatted by the backend provider.
    public sealed record ApiMember(
    string Uid,
    string Name,
    MemberKind Kind,
    string TypeDisplay,
    string? DefaultValue,
    bool IsRequired,
    bool HasInheritDocDirective,
    ParsedXmlDoc Xmldoc,
    string? SignatureHtml,
    ImmutableArray<ApiParameter> Parameters,
    string? ReturnTypeDisplay,
    string? InheritedFromUid = null,
    string? InheritedFromName = null);

    /// Formatted default value literal, or null when none is declared.
    string? DefaultValue;

    /// Whether the source xmldoc carried an <inheritdoc/> directive; consumers use this to suppress "missing summary" diagnostics when inheritance didn't resolve.
    bool HasInheritDocDirective;

    /// When the member is inherited, the short name of the declaring type for grouping headers (e.g. IContentEmitter). null for directly-declared members.
    string? InheritedFromName = null;

    /// When the member is inherited from a base interface (rather than declared on the queried type), the xmldocid of the declaring type. null for directly-declared members.
    string? InheritedFromUid = null;

    /// Whether the member carries the required modifier.
    bool IsRequired;

    /// The kind of member this record represents.
    MemberKind Kind;

    /// Display name of the member (for methods, includes type-parameter list; for constructors, the containing type name).
    string Name;

    /// Formatted parameter list for methods/constructors; empty for properties/fields/events.
    ImmutableArray<ApiParameter> Parameters;

    /// Formatted return type for methods that return a value; null otherwise.
    string? ReturnTypeDisplay;

    /// Pre-highlighted declaration HTML ready to inject with @((MarkupString)…), or null when no declaration signature is available.
    string? SignatureHtml;

    /// Human-readable type signature (return type for methods, declared type for properties/fields/events).
    string TypeDisplay;

    /// Canonical xmldocid (e.g. M:Namespace.Type.Method(System.Int32)).
    string Uid;

    /// Parsed xmldoc for the member.
    ParsedXmlDoc Xmldoc;
}