ApiTypeSummary
Pennington.ApiMetadata
Lightweight header describing a documented type, used for listings, slug disambiguation, and cross-link display names.
Properties
Assemblystring- Declaring assembly name without extension.
FullTypeNamestring- Fully-qualified type name (namespace + dot + type name).
KindApiTypeKind- Category of the type.
Namestring- Short type name without namespace (e.g.
ContentPipeline). Namespacestring- Fully-qualified containing namespace, empty for the global namespace.
Summarystring- First-sentence plain-text summary, or
nullwhen no xmldoc summary is available. Uidstring- 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
Uidstring- Canonical xmldocid (e.g.
T:Namespace.TypeName). Normalized to xmldocid form regardless of source backend. Namestring- Short type name without namespace (e.g.
ContentPipeline). Namespacestring- Fully-qualified containing namespace, empty for the global namespace.
Assemblystring- Declaring assembly name without extension.
KindApiTypeKind- Category of the type.
Summarystring- First-sentence plain-text summary, or
nullwhen 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; }
}