PublicApiOptions Class
public sealed class PublicApiOptionsNo documentation is available.
Constructors
| Name | Description |
|---|---|
| PublicApiOptions() |
PublicApiOptions()
PublicApiOptions.cspublic PublicApiOptions()No documentation is available.
Properties
| Name | Description |
|---|---|
| DeleteUnexpectedFiles | Gets or sets a value indicating whether GenerateToDirectory deletes the files of the output directory that it does not write, such as the files of removed types, and the directories that are empty after that. Only set it when the directory only contains the generated files. The default value is false. |
| ExcludedAssemblyReferences | Gets the patterns of the names of the assemblies not to write when PublicApiOptions.IncludeAssemblyReferences is true. A pattern can contain * (any characters) and ? (one character), and is compared without case. It wins over PublicApiOptions.IncludedAssemblyReferences. |
| FileLayout | |
| IncludeAllAttributes | Gets or sets a value indicating whether the attributes that are part of the API contract but are not written by default are written: EditorBrowsableAttribute, the attributes of the other namespaces than System whose type is visible outside the assembly, and the assembly attributes (e.g. InternalsVisibleToAttribute). The attributes that only matter to the compiler or to the runtime, the ones that are represented by the C# syntax (e.g. NullableAttribute or ExtensionAttribute), and the assembly attributes that the SDK generates from the properties of the project (e.g. AssemblyCompanyAttribute or TargetFrameworkAttribute) are never written. The default value is false. |
| IncludeAssemblyReferences | Gets or sets a value indicating whether the header lists the simple names of the referenced assemblies, so that adding or removing a dependency shows up in the generated files. When the assembly has a .deps.json file, only the assemblies it lists (packages, project references and referenced files) are written, not the assemblies of the framework. Otherwise, every referenced assembly is written. PublicApiOptions.IncludedAssemblyReferences and PublicApiOptions.ExcludedAssemblyReferences change the list. When the target frameworks do not reference the same assemblies, the name of an assembly that only some of them reference is followed by these target frameworks. The default value is false. |
| IncludeAutoGeneratedComment | |
| IncludedAssemblyReferences | Gets the patterns of the names of the framework assemblies to write when PublicApiOptions.IncludeAssemblyReferences is true (e.g. System.Net.*). A pattern can contain * (any characters) and ? (one character), and is compared without case. |
DeleteUnexpectedFiles
PublicApiOptions.csGets or sets a value indicating whether GenerateToDirectory deletes the files of the output directory that it does not write, such as the files of removed types, and the directories that are empty after that. Only set it when the directory only contains the generated files. The default value is false.
public bool DeleteUnexpectedFiles { get; set; }Property value
ExcludedAssemblyReferences
PublicApiOptions.csGets the patterns of the names of the assemblies not to write when PublicApiOptions.IncludeAssemblyReferences is true. A pattern can contain * (any characters) and ? (one character), and is compared without case. It wins over PublicApiOptions.IncludedAssemblyReferences.
Property value
FileLayout
PublicApiOptions.csIncludeAllAttributes
PublicApiOptions.csGets or sets a value indicating whether the attributes that are part of the API contract but are not written by default are written: EditorBrowsableAttribute, the attributes of the other namespaces than System whose type is visible outside the assembly, and the assembly attributes (e.g. InternalsVisibleToAttribute). The attributes that only matter to the compiler or to the runtime, the ones that are represented by the C# syntax (e.g. NullableAttribute or ExtensionAttribute), and the assembly attributes that the SDK generates from the properties of the project (e.g. AssemblyCompanyAttribute or TargetFrameworkAttribute) are never written. The default value is false.
public bool IncludeAllAttributes { get; set; }Property value
IncludeAssemblyReferences
PublicApiOptions.csGets or sets a value indicating whether the header lists the simple names of the referenced assemblies, so that adding or removing a dependency shows up in the generated files. When the assembly has a .deps.json file, only the assemblies it lists (packages, project references and referenced files) are written, not the assemblies of the framework. Otherwise, every referenced assembly is written. PublicApiOptions.IncludedAssemblyReferences and PublicApiOptions.ExcludedAssemblyReferences change the list. When the target frameworks do not reference the same assemblies, the name of an assembly that only some of them reference is followed by these target frameworks. The default value is false.
public bool IncludeAssemblyReferences { get; set; }Property value
IncludeAutoGeneratedComment
PublicApiOptions.csIncludedAssemblyReferences
PublicApiOptions.csGets the patterns of the names of the framework assemblies to write when PublicApiOptions.IncludeAssemblyReferences is true (e.g. System.Net.*). A pattern can contain * (any characters) and ? (one character), and is compared without case.