Class DotnetApiCatalog

Namespace: Docfx.Dotnet

Assembly: Docfx.Dotnet.dll

Provides access to a .NET API definitions and their associated documentation.

public static class DotnetApiCatalog

Inheritance

DotnetApiCatalog

Inherited Members

object.Equals(object?)

object.Equals(object?, object?)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object?, object?)

object.ToString()

Methods

GenerateManagedReferenceYamlFiles(string)

Generates metadata reference YAML files using docfx.json config.

public static Task GenerateManagedReferenceYamlFiles(string configPath)

Parameters

configPath string: The path to docfx.json config file.

Returns

Task: A task to await for build completion.

GenerateManagedReferenceYamlFiles(string, DotnetApiOptions)

Generates metadata reference YAML files using docfx.json config.

public static Task GenerateManagedReferenceYamlFiles(string configPath, DotnetApiOptions options)

Parameters

configPath string: The path to docfx.json config file.
options DotnetApiOptions

Returns

Task: A task to await for build completion.