Summary.Pipelines.FilteringExtensions.md

Summary.Pipelines.FilteringExtensions

public static class FilteringExtensions

A set of extensions for SummaryPipeline that add support for filtering functionality.

Methods

UseDefaultFilters(SummaryPipeline)

public static SummaryPipeline UseDefaultFilters(this SummaryPipeline self)

Enables default filters for the given pipeline (i.e. a filter that removes all non-public members).

IncludeAtLeast(SummaryPipeline, AccessModifier)

public static SummaryPipeline IncludeAtLeast(this SummaryPipeline self, AccessModifier access)

Includes only members that have at least the given access modifier.

Example

In order to include both internal and public members in the generated docs, you can call this method as follows:

var pipeline = ...;

pipeline.IncludeAtLeast(AccessModifier.Internal);

IncludeOnly(SummaryPipeline, AccessModifier)

public static SummaryPipeline IncludeOnly(this SummaryPipeline self, AccessModifier access)

Includes only members that have at least the given access modifier.

Example

In order to include onl internal members in the generated docs, you can call this method as follows:

var pipeline = ...;

pipeline.IncludeOnly(AccessModifier.Internal);

WithAccess(SummaryPipeline, Func<AccessModifier, bool>)

public static SummaryPipeline WithAccess(this SummaryPipeline self, Func<AccessModifier, bool> p)

Includes only members that have the access modifier that satisfies the given predicate.

UseFilter(SummaryPipeline, IPipe<Doc, Doc>)

public static SummaryPipeline UseFilter(this SummaryPipeline self, IPipe<Doc, Doc> filter)

Adds the given filter into the pipeline.