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

ApiTypeSummary Pennington.ApiMetadata

Lightweight header describing a documented type, used for listings, slug disambiguation, and cross-link display names.

Properties

Assembly string
Declaring assembly name without extension.
FullTypeName string
Fully-qualified type name (namespace + dot + type name).
Kind ApiTypeKind
Category of the type.
Name string
Short type name without namespace (e.g. ContentPipeline).
Namespace string
Fully-qualified containing namespace, empty for the global namespace.
Summary string
First-sentence plain-text summary, or null when no xmldoc summary is available.
Uid string
Canonical xmldocid (e.g. T:Namespace.TypeName). Normalized to xmldocid form regardless of source backend.

Constructors

ApiTypeSummary

#
public ApiTypeSummary(string Uid, string Name, string Namespace, string Assembly, ApiTypeKind Kind, string Summary)

Lightweight header describing a documented type, used for listings, slug disambiguation, and cross-link display names.

Parameters

Uid string
Canonical xmldocid (e.g. T:Namespace.TypeName). Normalized to xmldocid form regardless of source backend.
Name string
Short type name without namespace (e.g. ContentPipeline).
Namespace string
Fully-qualified containing namespace, empty for the global namespace.
Assembly string
Declaring assembly name without extension.
Kind ApiTypeKind
Category of the type.
Summary string
First-sentence plain-text summary, or null when no xmldoc summary is available.

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 ApiTypeSummary(string Uid, string Name, string Namespace, string Assembly, ApiTypeKind Kind, string Summary)
; /// Declaring assembly name without extension.
public string Assembly { get; set; }
/// Fully-qualified type name (namespace + dot + type name).
public string FullTypeName { get; }
/// Category of the type.
public ApiTypeKind Kind { get; set; }
/// Short type name without namespace (e.g. ContentPipeline).
public string Name { get; set; }
/// Fully-qualified containing namespace, empty for the global namespace.
public string Namespace { get; set; }
/// First-sentence plain-text summary, or null when no xmldoc summary is available.
public string Summary { get; set; }
/// Canonical xmldocid (e.g. T:Namespace.TypeName). Normalized to xmldocid form regardless of source backend.
public string Uid { get; set; }
}