PublicApiFormattingOptions Class

Options for PublicApiFormatter.

public sealed class PublicApiFormattingOptions

Constructors

NameDescription
PublicApiFormattingOptions()

PublicApiFormattingOptions()

PublicApiFormattingOptions.cs
public PublicApiFormattingOptions()

No documentation is available.

Properties

NameDescription
AttributeFilterGets or sets a predicate that selects the attributes to write. When it is null, the attributes of the System namespaces are written, except the ones that only matter to the compiler or that are represented by the C# syntax (e.g. NullableAttribute, ExtensionAttribute or EditorBrowsableAttribute).
IncludeAttributesGets or sets a value indicating whether attributes are written. The default value is true.
NewLineGets or sets the string used to separate lines. The default value is Environment.NewLine.
QualifyTypeNamesGets or sets a value indicating whether type names include their namespace in the PublicApiDeclarationStyle.Declaration style. The default value is true. Segments reference the types in both cases.
Style

Gets or sets a predicate that selects the attributes to write. When it is null, the attributes of the System namespaces are written, except the ones that only matter to the compiler or that are represented by the C# syntax (e.g. NullableAttribute, ExtensionAttribute or EditorBrowsableAttribute).

public Func<PublicApiAttribute, bool>? AttributeFilter { get; set; }

Gets or sets a value indicating whether attributes are written. The default value is true.

public bool IncludeAttributes { get; set; }

Property value

bool

Gets or sets the string used to separate lines. The default value is Environment.NewLine.

public string NewLine { get; set; }

Property value

string

Gets or sets a value indicating whether type names include their namespace in the PublicApiDeclarationStyle.Declaration style. The default value is true. Segments reference the types in both cases.

public bool QualifyTypeNames { get; set; }

Property value

bool

public PublicApiDeclarationStyle Style { get; set; }

No documentation is available.