This site provides a machine-readable index at /llms.txt.

Skip to main content Skip to navigation

ApiReferenceOptions Pennington.Roslyn.ApiMetadata

Filters applied by RoslynApiMetadataProvider when walking the Roslyn workspace.

Properties

ProjectFilter System.Predicate<Project>?
Default: null
Predicate selecting which projects contribute types. Defaults to DefaultProjectFilter when unset.
TypeFilter System.Predicate<INamedTypeSymbol>?
Default: null
Extra per-type inclusion predicate applied on top of the built-in rules (public, non-delegate, non-attribute, non-ComponentBase, has xmldoc).

Methods

DefaultProjectFilter

#
public static Predicate<Project> DefaultProjectFilter();

Built-in project filter that excludes *.Tests / *.IntegrationTests and the entry assembly.

Returns

Predicate<Project>

Pennington.Roslyn.ApiMetadata.ApiReferenceOptions

namespace Pennington.Roslyn.ApiMetadata;

/// Filters applied by RoslynApiMetadataProvider when walking the Roslyn workspace.
public record ApiReferenceOptions
{
    /// Built-in project filter that excludes *.Tests / *.IntegrationTests and the entry assembly.
    
public static Predicate<Project> DefaultProjectFilter();
/// Predicate selecting which projects contribute types. Defaults to DefaultProjectFilter when unset.
public Predicate<Project>? ProjectFilter { get; set; }
/// Extra per-type inclusion predicate applied on top of the built-in rules (public, non-delegate, non-attribute, non-ComponentBase, has xmldoc).
public Predicate<INamedTypeSymbol>? TypeFilter { get; set; }
}