ApiReferenceExportOptions Constructors

ClassConstructors1 member

Describes the package identity and ownership scope of an IApiReferenceExporter export.

Constructor(string, string, IReadOnlyCollection<string>)

Initializes a new instance of the ApiReferenceExportOptions class.

public sealed class ApiReferenceExportOptions
{
    public ApiReferenceExportOptions(
        string packageName,
        string packageVersion,
        IReadOnlyCollection<string> exportingAssemblyNames)
    {
        // ...
    }
}

ApiReferenceExportOptions.cs#L42-L62

Parameters

packageNamestringThe name of the package being exported.

packageVersionstringThe version label to record for the package being exported.

exportingAssemblyNamesIReadOnlyCollection<string> The assemblies whose symbols this package owns and documents. Symbols outside this set are present only to complete the reference closure.

Exceptions

ArgumentNullException Thrown when packageName, packageVersion, or exportingAssemblyNames is null.

ArgumentException Thrown when packageName or packageVersion is empty or consists only of white-space characters, or when exportingAssemblyNames is empty or contains a null, empty, or white-space assembly name.