This documentation is also published as Markdown for efficient machine reading: the whole site is indexed at /llms.txt, and every page has a clean Markdown copy under /_llms/. These are generated from the same source and cost far fewer tokens to read than this rendered HTML.

Skip to main content Skip to navigation

CompiledAssemblyApiOptions Pennington.ApiMetadata.Reflection

Options for CompiledAssemblyApiMetadataProvider.

Properties

AssemblyDirectories IList<string>
Directories to scan for *.dll files with matching *.xml xmldoc files. Every matched pair in each directory contributes types to the provider. Use this when every .dll in the folder is intended for documentation — the typical NuGet lib/<tfm>/ layout.
AssemblyFiles IList<string>
Explicit .dll paths to document. Use this when a folder contains more assemblies than you want documented (e.g. dependencies copied alongside the target for MetadataLoadContext resolution). The companion .xml file is loaded from the same directory. When both AssemblyDirectories and AssemblyFiles are set, both contribute.

Pennington.ApiMetadata.Reflection.CompiledAssemblyApiOptions

namespace Pennington.ApiMetadata.Reflection;

/// Options for CompiledAssemblyApiMetadataProvider.
public class CompiledAssemblyApiOptions
{
    /// Directories to scan for *.dll files with matching *.xml xmldoc files. Every matched pair in each directory contributes types to the provider. Use this when every .dll in the folder is intended for documentation — the typical NuGet lib/<tfm>/ layout.
    
public IList<string> AssemblyDirectories { get; }
/// Explicit .dll paths to document. Use this when a folder contains more assemblies than you want documented (e.g. dependencies copied alongside the target for MetadataLoadContext resolution). The companion .xml file is loaded from the same directory. When both AssemblyDirectories and AssemblyFiles are set, both contribute.
public IList<string> AssemblyFiles { get; }
}