ApiReferenceItem

class

Namespace: MyLittleContentEngine.Models

Base class for API reference items

Declaration

public abstract record ApiReferenceItem

Inheritance

object → ApiReferenceItem

Implements

  • System.IEquatable<MyLittleContentEngine.Models.ApiReferenceItem>

Propertys

Declaration

property
public required string Declaration { get; init; }
Declaration syntax as a string
Returns: string ApiReferenceItem.Declaration

FullName

property
public required string FullName { get; init; }
Full name including namespace
Returns: string ApiReferenceItem.FullName

MicrosoftStyleId

property
public required string MicrosoftStyleId { get; init; }
Microsoft-style identifier (e.g., namespace.typename.membername)
Returns: string ApiReferenceItem.MicrosoftStyleId

MinimalFullName

property
public required string MinimalFullName { get; init; }
Full name including namespace, with minimal formatting
Returns: string ApiReferenceItem.MinimalFullName

Name

property
public required string Name { get; init; }
Display name of the item
Returns: string ApiReferenceItem.Name

Remarks

property
public string? Remarks { get; init; }
XML documentation remarks
Returns: string? ApiReferenceItem.Remarks

Summary

property
public string? Summary { get; init; }
XML documentation summary
Returns: string? ApiReferenceItem.Summary

XmlDocId

property
public required string XmlDocId { get; init; }
XML Documentation ID
Returns: string ApiReferenceItem.XmlDocId