PublicApiFormattingOptions Class
Options for PublicApiFormatter.
public sealed class PublicApiFormattingOptionsConstructors
| Name | Description |
|---|---|
| PublicApiFormattingOptions() |
PublicApiFormattingOptions()
PublicApiFormattingOptions.cspublic PublicApiFormattingOptions()No documentation is available.
Properties
| Name | Description |
|---|---|
| AttributeFilter | 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). |
| IncludeAttributes | Gets or sets a value indicating whether attributes are written. The default value is true. |
| NewLine | Gets or sets the string used to separate lines. The default value is Environment.NewLine. |
| QualifyTypeNames | 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. |
| Style |
AttributeFilter
PublicApiFormattingOptions.csGets 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; }Property value
IncludeAttributes
PublicApiFormattingOptions.csGets or sets the string used to separate lines. The default value is Environment.NewLine.
public string NewLine { get; set; }Property value
QualifyTypeNames
PublicApiFormattingOptions.csGets 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; }