Table of Contents

Class DotnetApiOptions

Namespace
Docfx.Dotnet
Assembly
Docfx.Dotnet.dll

Provides options to be used with Docfx.Dotnet.DotnetApiCatalog.GenerateManagedReferenceYamlFiles(System.String,Docfx.Dotnet.DotnetApiOptions).

public class DotnetApiOptions

Inheritance

Inherited Members

Properties

IncludeApi

Customizes the namespaces and types to include in the API catalog. Excluding a parent symbol exclude all child symbols underneath it.

public Func<ISymbol, SymbolIncludeState>? IncludeApi { get; init; }

Property Value

Func<ISymbol, SymbolIncludeState>?

IncludeAttribute

Customizes the attributes to include in the API catalog. Excluding a parent symbol exclude all child symbols underneath it.

public Func<ISymbol, SymbolIncludeState>? IncludeAttribute { get; init; }

Property Value

Func<ISymbol, SymbolIncludeState>?

SourceUrl

Customizes the view source URL for files in a git repository. Returns null to use built-in support for GitHub, Azure Repos, etc.

public Func<GitSource, string?>? SourceUrl { get; init; }

Property Value

Func<GitSource, string?>?