PublicApi Class

public static class PublicApi

No documentation is available.

Methods

NameDescription
Aggregate(IReadOnlyList<PublicApiAssembly>)Aggregates the builds of an assembly for several target frameworks, to find the symbols that are specific to some of them and the declarations that differ.
Generate(IReadOnlyList<AssemblySource>, PublicApiOptions?)
Generate(Assembly, PublicApiOptions?)
Generate(string, PublicApiOptions?)
GenerateToDirectory(IReadOnlyList<AssemblySource>, string, PublicApiOptions?)
GenerateToDirectory(Assembly, string, PublicApiOptions?)
GenerateToDirectory(string, string, PublicApiOptions?)
ReadAssembly(Stream, PublicApiReadOptions?)Reads the public API of an assembly from a stream that contains a PE image, without loading it. The stream is not closed.
ReadAssembly(string, PublicApiReadOptions?)Reads the public API of an assembly file, without loading it.

Aggregate(IReadOnlyList<PublicApiAssembly>)

PublicApi.cs

Aggregates the builds of an assembly for several target frameworks, to find the symbols that are specific to some of them and the declarations that differ.

public static PublicApiAggregatedAssembly Aggregate(IReadOnlyList<PublicApiAssembly> assemblies)

Parameters

assemblies IReadOnlyList<PublicApiAssembly>
The builds of the same assembly. They must have the same name and distinct target frameworks.

Returns

PublicApiAggregatedAssembly

Generate overloads

Generate(IReadOnlyList<AssemblySource>, PublicApiOptions?)

PublicApi.cs
public static IReadOnlyList<PublicApiFile> Generate(IReadOnlyList<AssemblySource> assemblySources, PublicApiOptions? options = null)

No documentation is available.

Generate(Assembly, PublicApiOptions?)

PublicApi.cs
public static IReadOnlyList<PublicApiFile> Generate(Assembly assembly, PublicApiOptions? options = null)

No documentation is available.

Generate(string, PublicApiOptions?)

PublicApi.cs
public static IReadOnlyList<PublicApiFile> Generate(string assemblyPath, PublicApiOptions? options = null)
Parameters
assemblyPath string
options PublicApiOptions?
Returns

IReadOnlyList<PublicApiFile>

No documentation is available.

GenerateToDirectory overloads

GenerateToDirectory(IReadOnlyList<AssemblySource>, string, PublicApiOptions?)

PublicApi.cs
public static void GenerateToDirectory(IReadOnlyList<AssemblySource> assemblySources, string outputDirectory, PublicApiOptions? options = null)
Parameters
assemblySources IReadOnlyList<AssemblySource>
outputDirectory string
options PublicApiOptions?

No documentation is available.

GenerateToDirectory(Assembly, string, PublicApiOptions?)

PublicApi.cs
public static void GenerateToDirectory(Assembly assembly, string outputDirectory, PublicApiOptions? options = null)
Parameters
assembly Assembly
outputDirectory string
options PublicApiOptions?

No documentation is available.

GenerateToDirectory(string, string, PublicApiOptions?)

PublicApi.cs
public static void GenerateToDirectory(string assemblyPath, string outputDirectory, PublicApiOptions? options = null)
Parameters
assemblyPath string
outputDirectory string
options PublicApiOptions?

No documentation is available.

ReadAssembly overloads

ReadAssembly(Stream, PublicApiReadOptions?)

PublicApi.cs

Reads the public API of an assembly from a stream that contains a PE image, without loading it. The stream is not closed.

public static PublicApiAssembly ReadAssembly(Stream stream, PublicApiReadOptions? options = null)
Parameters
stream Stream
options PublicApiReadOptions?
Returns

PublicApiAssembly

ReadAssembly(string, PublicApiReadOptions?)

PublicApi.cs

Reads the public API of an assembly file, without loading it.

public static PublicApiAssembly ReadAssembly(string assemblyPath, PublicApiReadOptions? options = null)
Parameters
assemblyPath string
options PublicApiReadOptions?
Returns

PublicApiAssembly