Meziantou.Framework.PublicApiGenerator namespace

Classes

NameDescription
AssemblySource
PublicApi
PublicApiAggregatedAssemblyThe public API of an assembly built for several target frameworks. See PublicApi.Aggregate.
PublicApiAggregatedSymbolA type or a member of an PublicApiAggregatedAssembly, identified by its documentation ID.
PublicApiArrayTypeReferenceA reference to an array type.
PublicApiAssemblyThe public API of an assembly, read from its metadata.
PublicApiAttributeA custom attribute applied to an assembly, a symbol, a parameter, a return value or a generic parameter.
PublicApiAttributeArgumentA value passed to a custom attribute.
PublicApiAttributeNamedArgumentA value assigned to a field or a property of a custom attribute.
PublicApiDeclarationSegmentA part of a formatted declaration, with the symbol or the type it refers to.
PublicApiEventAn event.
PublicApiExtensionBlockA C# 14 extension block (e.g. extension<T>(List<T> list) { ... }) declared in a static class.
PublicApiFieldA field, a constant, or an enum member.
PublicApiFile
PublicApiFormattedDeclarationThe C# representation of a symbol or of a type, split into segments.
PublicApiFormatterFormats the symbols of a PublicApiAssembly as C# code.
PublicApiFormattingOptionsOptions for PublicApiFormatter.
PublicApiFunctionPointerParameterA parameter of a PublicApiFunctionPointerTypeReference.
PublicApiFunctionPointerTypeReferenceA reference to a function pointer type (e.g. delegate*<int, void>).
PublicApiGenericParameterA generic parameter of a type or of a method, with its constraints.
PublicApiMemberA field, a property, an event or a method.
PublicApiMemberReferenceA reference to a member of another type, such as the interface member implemented by an explicit interface implementation.
PublicApiMetadataOriginIdentifies the metadata entity a symbol was read from. A metadata token is only meaningful within the module that owns it, so it is always paired with the module version ID (MVID). Tokens are not stable across builds.
PublicApiMethodA method, a constructor, an operator, a destructor, or an accessor of a property or an event.
PublicApiModuleThe manifest module of an assembly.
PublicApiNamedTypeReferenceA reference to a class, struct, interface, enum or delegate, optionally constructed with type arguments.
PublicApiOptions
PublicApiParameterA parameter of a method, an indexer or a delegate.
PublicApiPdbReferenceThe CodeView debug directory entry of a module, which identifies the PDB that matches the module.
PublicApiPointerTypeReferenceA reference to an unmanaged pointer type.
PublicApiPropertyA property or an indexer.
PublicApiReadOptionsOptions for PublicApi.ReadAssembly.
PublicApiSymbolA type or a member that is part of the public API of an assembly.
PublicApiSymbolIdentityIdentifies a symbol across assemblies. The documentation ID alone is not unique: unrelated assemblies, or the builds of the same assembly for several target frameworks, can declare symbols with the same documentation ID.
PublicApiSymbolVariantA declaration shared by the target frameworks listed in PublicApiSymbolVariant.TargetFrameworks.
PublicApiTypeA class, struct, interface, enum or delegate that is part of the public API.
PublicApiTypeModel
PublicApiTypeParameterReferenceA reference to a generic parameter of a type or of a method.
PublicApiTypeReferenceA reference to a type, as it appears in a signature, a base type list, a constraint or an attribute argument.

Enums

NameDescription
PublicApiAccessibilityThe declared accessibility of a symbol. Values are ordered from the least to the most accessible.
PublicApiAttributeArgumentKindIdentifies the kind of value stored in a PublicApiAttributeArgument.
PublicApiAttributeNamedArgumentKindIdentifies whether a named attribute argument sets a field or a property.
PublicApiCallingConventionThe calling convention of a function pointer type.
PublicApiDeclarationSegmentKindIdentifies the kind of a PublicApiDeclarationSegment.
PublicApiDeclarationStyleThe style of the C# code produced by PublicApiFormatter.
PublicApiFileLayout
PublicApiMethodKindIdentifies the kind of a PublicApiMethod.
PublicApiNullableAnnotationThe nullable annotation of a type reference, as encoded by the C# compiler.
PublicApiRefKindHow a parameter, a return value or a field is passed.
PublicApiSymbolDifferencesThe parts of a declaration that differ between the variants of an aggregated symbol.
PublicApiSymbolKindIdentifies the kind of a PublicApiSymbol.
PublicApiTypeKindIdentifies the kind of a PublicApiType.
PublicApiTypeReferenceKindIdentifies the kind of a PublicApiTypeReference.
PublicApiVarianceThe variance of a generic parameter.