Pennington.ApiMetadata.ApiTypeSummary

namespace Pennington.ApiMetadata;

/// Lightweight header describing a documented type, used for listings, slug disambiguation, and cross-link display names.
public record ApiTypeSummary
{
    /// Lightweight header describing a documented type, used for listings, slug disambiguation, and cross-link display names.
    
public sealed record ApiTypeSummary(
    string Uid,
    string Name,
    string Namespace,
    string Assembly,
    ApiTypeKind Kind,
    string? Summary)
{
    /// <summary>Fully-qualified type name (namespace + dot + type name).</summary>
    public string FullTypeName =>
        string.IsNullOrEmpty(Namespace) ? Name : $"{Namespace}.{Name}";
}

    /// Declaring assembly name without extension.
    
string Assembly
;

    /// Fully-qualified type name (namespace + dot + type name).
    
public string FullTypeName =>
    string.IsNullOrEmpty(Namespace) ? Name : $"{Namespace}.{Name}";

    /// Category of the type.
    
ApiTypeKind Kind
;

    /// Short type name without namespace (e.g. ContentPipeline).
    
string Name
;

    /// Fully-qualified containing namespace, empty for the global namespace.
    
string Namespace
;

    /// First-sentence plain-text summary, or null when no xmldoc summary is available.
    
string? Summary
;

    /// Canonical xmldocid (e.g. T:Namespace.TypeName). Normalized to xmldocid form regardless of source backend.
    
string Uid
;
}