Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Index page #57

Merged
merged 3 commits into from
Dec 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
102 changes: 102 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
# Summary
- [**Summary.Doc**](Summary.Doc.md)
- [**Summary.DocComment**](Summary.DocComment.md)
- [**Summary.DocCommentElement**](Summary.DocCommentElement.md)
- [**Summary.DocCommentElementAttribute**](Summary.DocCommentElementAttribute.md)
- [**Summary.DocCommentInheritDoc**](Summary.DocCommentInheritDoc.md)
- [**Summary.DocCommentLink**](Summary.DocCommentLink.md)
- [**Summary.DocCommentLiteral**](Summary.DocCommentLiteral.md)
- [**Summary.DocCommentNode**](Summary.DocCommentNode.md)
- [**Summary.DocCommentParamRef**](Summary.DocCommentParamRef.md)
- [**Summary.DocDeprecation**](Summary.DocDeprecation.md)
- [**Summary.DocEvent**](Summary.DocEvent.md)
- [**Summary.DocExtensions**](Summary.DocExtensions.md)
- [**Summary.DocField**](Summary.DocField.md)
- [**Summary.DocIndexer**](Summary.DocIndexer.md)
- [**Summary.DocLocation**](Summary.DocLocation.md)
- [**Summary.DocMember**](Summary.DocMember.md)
- [**Summary.DocMethod**](Summary.DocMethod.md)
- [**Summary.DocParam**](Summary.DocParam.md)
- [**Summary.DocProperty**](Summary.DocProperty.md)
- [**Summary.DocPropertyAccessor**](Summary.DocPropertyAccessor.md)
- [**Summary.DocType**](Summary.DocType.md)
- [**Summary.DocTypeDeclaration**](Summary.DocTypeDeclaration.md)
- [**Summary.DocTypeParam**](Summary.DocTypeParam.md)

# Summary.Tests
- [**Summary.Tests.Extensions**](Summary.Tests.Extensions.md)

# Summary.Cli.Logging
- [**Summary.Cli.Logging.ConsoleLoggerFactory**](Summary.Cli.Logging.ConsoleLoggerFactory.md)

# Summary.Caching
- [**Summary.Caching.CrefCache**](Summary.Caching.CrefCache.md)

# Summary.Pipelines
- [**Summary.Pipelines.SummaryPipeline**](Summary.Pipelines.SummaryPipeline.md)
- [**Summary.Pipelines.SummaryPipeline.Options**](Summary.Pipelines.SummaryPipeline.Options.md)
- [**Summary.Pipelines.SummaryPipelineExtensions**](Summary.Pipelines.SummaryPipelineExtensions.md)
- [**Summary.Pipelines.FilteringExtensions**](Summary.Pipelines.FilteringExtensions.md)

# Summary.Pipes
- [**Summary.Pipes.FoldPipe<O>**](Summary.Pipes.FoldPipe{O}.md)
- [**Summary.Pipes.FuncPipe<I, O>**](Summary.Pipes.FuncPipe{I,O}.md)
- [**Summary.Pipes.IPipe<I, O>**](Summary.Pipes.IPipe{I,O}.md)
- [**Summary.Pipes.PipeExtensions**](Summary.Pipes.PipeExtensions.md)
- [**Summary.Pipes.TeePipe<I, O>**](Summary.Pipes.TeePipe{I,O}.md)
- [**Summary.Pipes.ThenForEach<I, O1, O2>**](Summary.Pipes.ThenForEach{I,O1,O2}.md)
- [**Summary.Pipes.ThenPipe<I, O1, O2>**](Summary.Pipes.ThenPipe{I,O1,O2}.md)
- [**Summary.Pipes.Unit**](Summary.Pipes.Unit.md)

# Summary.Samples
- [**Summary.Samples.InheritDocBase**](Summary.Samples.InheritDocBase.md)
- [**Summary.Samples.InheritDoc_Child**](Summary.Samples.InheritDoc_Child.md)
- [**Summary.Samples.InheritDoc_Child2**](Summary.Samples.InheritDoc_Child2.md)
- [**Summary.Samples.InheritDoc_CrefBase**](Summary.Samples.InheritDoc_CrefBase.md)
- [**Summary.Samples.InheritDoc_CrefBase_Child**](Summary.Samples.InheritDoc_CrefBase_Child.md)
- [**Summary.Samples.InheritDoc_Child_OverrideSummary**](Summary.Samples.InheritDoc_Child_OverrideSummary.md)
- [**Summary.Samples.InheritDoc_Child_OverrideSummary2**](Summary.Samples.InheritDoc_Child_OverrideSummary2.md)
- [**Summary.Samples.IInheritDocBase**](Summary.Samples.IInheritDocBase.md)
- [**Summary.Samples.InheritDoc_InterfaceChild**](Summary.Samples.InheritDoc_InterfaceChild.md)
- [**Summary.Samples.InheritDocRecordBase**](Summary.Samples.InheritDocRecordBase.md)
- [**Summary.Samples.InheritDocRecordBase_Child**](Summary.Samples.InheritDocRecordBase_Child.md)
- [**Summary.Samples.Sample<T0, T1>**](Summary.Samples.Sample{T0,T1}.md)
- [**Summary.Samples.Sample<T0, T1>.Child**](Summary.Samples.Sample{T0,T1}.Child.md)

# Summary.Markdown
- [**Summary.Markdown.MarkdownPipelineExtensions**](Summary.Markdown.MarkdownPipelineExtensions.md)
- [**Summary.Markdown.Md**](Summary.Markdown.Md.md)
- [**Summary.Markdown.RenderMarkdownPipe**](Summary.Markdown.RenderMarkdownPipe.md)

# Summary.Roslyn
- [**Summary.Roslyn.RoslynPipelineExtensions**](Summary.Roslyn.RoslynPipelineExtensions.md)

# Summary.Tests.Core
- [**Summary.Tests.Core.PipesTests**](Summary.Tests.Core.PipesTests.md)

# Summary.Tests.Markdown
- [**Summary.Tests.Markdown.MarkdownTests**](Summary.Tests.Markdown.MarkdownTests.md)

# Summary.Tests.Roslyn
- [**Summary.Tests.Roslyn.RoslynParserTests**](Summary.Tests.Roslyn.RoslynParserTests.md)

# Summary.Pipes.Filters
- [**Summary.Pipes.Filters.FilterMemberPipe**](Summary.Pipes.Filters.FilterMemberPipe.md)

# Summary.Pipes.IO
- [**Summary.Pipes.IO.CleanupDirPipe<I>**](Summary.Pipes.IO.CleanupDirPipe{I}.md)
- [**Summary.Pipes.IO.SavePipe<I>**](Summary.Pipes.IO.SavePipe{I}.md)
- [**Summary.Pipes.IO.ScanPipe**](Summary.Pipes.IO.ScanPipe.md)
- [**Summary.Pipes.IO.Source**](Summary.Pipes.IO.Source.md)

# Summary.Pipes.Logging
- [**Summary.Pipes.Logging.LoggedPipe<I, O>**](Summary.Pipes.Logging.LoggedPipe{I,O}.md)

# Summary.Roslyn.CSharp
- [**Summary.Roslyn.CSharp.InlineInheritDocPipe**](Summary.Roslyn.CSharp.InlineInheritDocPipe.md)
- [**Summary.Roslyn.CSharp.ParseDocPipe**](Summary.Roslyn.CSharp.ParseDocPipe.md)
- [**Summary.Roslyn.CSharp.ParseSyntaxTreePipe**](Summary.Roslyn.CSharp.ParseSyntaxTreePipe.md)

# Summary.Roslyn.CSharp.Extensions
- [**Summary.Roslyn.CSharp.Extensions.DocMemberExtensions**](Summary.Roslyn.CSharp.Extensions.DocMemberExtensions.md)

4 changes: 2 additions & 2 deletions docs/Summary.Cli.Logging.ConsoleLoggerFactory.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ public static readonly ILogger Instance
public void Dispose()
```

### [Log<TState>(LogLevel, EventId, TState, Exception?<Exception>, Func<TState, Exception?<Exception>, string>)](../src/Cli/Logging/ConsoleLoggerFactory.cs#L41)
### [Log&lt;TState&gt;(LogLevel, EventId, TState, Exception?&lt;Exception&gt;, Func&lt;TState, Exception?&lt;Exception&gt;, string&gt;)](../src/Cli/Logging/ConsoleLoggerFactory.cs#L41)
```cs
public void Log<TState>(
LogLevel logLevel,
Expand All @@ -32,7 +32,7 @@ public void Log<TState>(
public bool IsEnabled(LogLevel logLevel)
```

### [BeginScope<TState>(TState)](../src/Cli/Logging/ConsoleLoggerFactory.cs#L51)
### [BeginScope&lt;TState&gt;(TState)](../src/Cli/Logging/ConsoleLoggerFactory.cs#L51)
```cs
public IDisposable? BeginScope<TState>(TState state)
```
Expand Down
2 changes: 1 addition & 1 deletion docs/Summary.Doc.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Merges two documents together returning the new merged document.
- `a`: The first document to merge.
- `b`: The second document to merge.

### [Declaration(DocType?<DocType>)](../src/Core/Doc.cs#L29)
### [Declaration(DocType?&lt;DocType&gt;)](../src/Core/Doc.cs#L29)
```cs
public DocTypeDeclaration? Declaration(DocType? type)
```
Expand Down
4 changes: 2 additions & 2 deletions docs/Summary.DocComment.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ A nested documentation element that has the specified name (e.g. `summary`, `rem
#### Parameters
- `tag`: The name of the element tag to search inside the comment.

### [Element(Func<DocCommentElement, bool>)](../src/Core/DocComment.cs#L47)
### [Element(Func&lt;DocCommentElement, bool&gt;)](../src/Core/DocComment.cs#L47)
```cs
public DocCommentElement? Element(Func<DocCommentElement, bool> p)
```
Expand All @@ -83,7 +83,7 @@ A sequence of nested documentation elements that have the specified name (e.g. `
#### Parameters
- `tag`: The name of the element tag to search inside the comment.

### [Elements(Func<DocCommentElement, bool>)](../src/Core/DocComment.cs#L61)
### [Elements(Func&lt;DocCommentElement, bool&gt;)](../src/Core/DocComment.cs#L61)
```cs
public IEnumerable<DocCommentElement> Elements(Func<DocCommentElement, bool> p)
```
Expand Down
4 changes: 2 additions & 2 deletions docs/Summary.Markdown.RenderMarkdownPipe.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# [Summary.Markdown.RenderMarkdownPipe](../src/Plugins/Markdown/RenderMarkdownPipe.cs#L8)
# [Summary.Markdown.RenderMarkdownPipe](../src/Plugins/Markdown/RenderMarkdownPipe.cs#L9)
```cs
public class RenderMarkdownPipe : IPipe<Doc, Md[]>
```

A [`IPipe<I, O>`](./Summary.Pipes.IPipe{I,O}.md) that renders generated document into the sequence of Markdown files.

## Methods
### [Run(Doc)](../src/Plugins/Markdown/RenderMarkdownPipe.cs#L10)
### [Run(Doc)](../src/Plugins/Markdown/RenderMarkdownPipe.cs#L11)
```cs
public Task<Md[]> Run(Doc doc)
```
Expand Down
4 changes: 2 additions & 2 deletions docs/Summary.Pipelines.FilteringExtensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,14 +45,14 @@ var pipeline = ...;
pipeline.IncludeOnly(AccessModifier.Internal);
```

### [WithAccess(SummaryPipeline, Func<AccessModifier, bool>)](../src/Core/Pipelines/SummaryPipelineFilteringExtensions.cs#L50)
### [WithAccess(SummaryPipeline, Func&lt;AccessModifier, bool&gt;)](../src/Core/Pipelines/SummaryPipelineFilteringExtensions.cs#L50)
```cs
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>)](../src/Core/Pipelines/SummaryPipelineFilteringExtensions.cs#L67)
### [UseFilter(SummaryPipeline, IPipe&lt;Doc, Doc&gt;)](../src/Core/Pipelines/SummaryPipelineFilteringExtensions.cs#L67)
```cs
public static SummaryPipeline UseFilter(this SummaryPipeline self, IPipe<Doc, Doc> filter)
```
Expand Down
10 changes: 5 additions & 5 deletions docs/Summary.Pipelines.SummaryPipeline.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,35 +36,35 @@ public Options UseLoggerFactory(ILoggerFactory loggers)

Specifies the logger factory that will be used to create loggers for the pipeline.

### [Customize(Func<Options, Options>)](../src/Core/Pipelines/SummaryPipeline.cs#L68)
### [Customize(Func&lt;Options, Options&gt;)](../src/Core/Pipelines/SummaryPipeline.cs#L68)
```cs
public SummaryPipeline Customize(Func<Options, Options> options)
```

Customizes the default pipeline options using the specified delegate.

### [ParseWith(Func<Options, IPipe<Unit, Doc>>)](../src/Core/Pipelines/SummaryPipeline.cs#L74)
### [ParseWith(Func&lt;Options, IPipe&lt;Unit, Doc&gt;&gt;)](../src/Core/Pipelines/SummaryPipeline.cs#L74)
```cs
public SummaryPipeline ParseWith(Func<Options, IPipe<Unit, Doc>> parser)
```

Specifies the custom parser with logging support for this pipeline.

### [ParseWith(IPipe<Unit, Doc>)](../src/Core/Pipelines/SummaryPipeline.cs#L83)
### [ParseWith(IPipe&lt;Unit, Doc&gt;)](../src/Core/Pipelines/SummaryPipeline.cs#L83)
```cs
public SummaryPipeline ParseWith(IPipe<Unit, Doc> parser)
```

Specifies the custom parser for this pipeline.

### [RenderWith(Func<Options, IPipe<Doc, Unit>>)](../src/Core/Pipelines/SummaryPipeline.cs#L92)
### [RenderWith(Func&lt;Options, IPipe&lt;Doc, Unit&gt;&gt;)](../src/Core/Pipelines/SummaryPipeline.cs#L92)
```cs
public SummaryPipeline RenderWith(Func<Options, IPipe<Doc, Unit>> render)
```

Specifies the custom renderer for this pipeline.

### [RenderWith(IPipe<Doc, Unit>)](../src/Core/Pipelines/SummaryPipeline.cs#L101)
### [RenderWith(IPipe&lt;Doc, Unit&gt;)](../src/Core/Pipelines/SummaryPipeline.cs#L101)
```cs
public SummaryPipeline RenderWith(IPipe<Doc, Unit> render)
```
Expand Down
2 changes: 1 addition & 1 deletion docs/Summary.Pipes.FoldPipe{O}.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# [Summary.Pipes.FoldPipe<O>](../src/Core/Pipes/FoldPipe.cs#L6)
# [Summary.Pipes.FoldPipe&lt;O&gt;](../src/Core/Pipes/FoldPipe.cs#L6)
```cs
public class FoldPipe<O> : IPipe<O[], O>
```
Expand Down
2 changes: 1 addition & 1 deletion docs/Summary.Pipes.FuncPipe{I,O}.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# [Summary.Pipes.FuncPipe<I, O>](../src/Core/Pipes/FuncPipe.cs#L6)
# [Summary.Pipes.FuncPipe&lt;I, O&gt;](../src/Core/Pipes/FuncPipe.cs#L6)
```cs
public class FuncPipe<I, O> : IPipe<I, O>
```
Expand Down
2 changes: 1 addition & 1 deletion docs/Summary.Pipes.IO.CleanupDirPipe{I}.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# [Summary.Pipes.IO.CleanupDirPipe<I>](../src/Core/Pipes/IO/CleanupDirPipe.cs#L6)
# [Summary.Pipes.IO.CleanupDirPipe&lt;I&gt;](../src/Core/Pipes/IO/CleanupDirPipe.cs#L6)
```cs
public class CleanupDirPipe<I> : IPipe<I, I>
```
Expand Down
2 changes: 1 addition & 1 deletion docs/Summary.Pipes.IO.SavePipe{I}.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# [Summary.Pipes.IO.SavePipe<I>](../src/Core/Pipes/IO/SavePipe.cs#L6)
# [Summary.Pipes.IO.SavePipe&lt;I&gt;](../src/Core/Pipes/IO/SavePipe.cs#L6)
```cs
public class SavePipe<I> : IPipe<I, Unit>
```
Expand Down
2 changes: 1 addition & 1 deletion docs/Summary.Pipes.IPipe{I,O}.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# [Summary.Pipes.IPipe<I, O>](../src/Core/Pipes/IPipe.cs#L8)
# [Summary.Pipes.IPipe&lt;I, O&gt;](../src/Core/Pipes/IPipe.cs#L8)
```cs
public interface IPipe<in I, O>
```
Expand Down
2 changes: 1 addition & 1 deletion docs/Summary.Pipes.Logging.LoggedPipe{I,O}.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# [Summary.Pipes.Logging.LoggedPipe<I, O>](../src/Core/Pipes/Logging/LoggedPipe.cs#L11)
# [Summary.Pipes.Logging.LoggedPipe&lt;I, O&gt;](../src/Core/Pipes/Logging/LoggedPipe.cs#L11)
```cs
public class LoggedPipe<I, O> : IPipe<I, O>
```
Expand Down
24 changes: 12 additions & 12 deletions docs/Summary.Pipes.PipeExtensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,84 +6,84 @@ public static class PipeExtensions
Extension methods for [`IPipe<I, O>`](./Summary.Pipes.IPipe{I,O}.md).

## Methods
### [Fold<I>(IPipe<I, Unit[]>)](../src/Core/Pipes/PipeExtensions.cs#L14)
### [Fold&lt;I&gt;(IPipe&lt;I, Unit[]&gt;)](../src/Core/Pipes/PipeExtensions.cs#L14)
```cs
public static IPipe<I, Unit> Fold<I>(this IPipe<I, Unit[]> self)
```

Folds the result of the specified pipe into a single [`Unit`](./Summary.Pipes.Unit.md) value.

### [Run<O>(IPipe<Unit, O>)](../src/Core/Pipes/PipeExtensions.cs#L20)
### [Run&lt;O&gt;(IPipe&lt;Unit, O&gt;)](../src/Core/Pipes/PipeExtensions.cs#L20)
```cs
public static Task<O> Run<O>(this IPipe<Unit, O> self)
```

Asynchronously runs the pipe.

### [Then<I, O1, O2>(IPipe<I, O1>, IPipe<O1, O2>)](../src/Core/Pipes/PipeExtensions.cs#L26)
### [Then&lt;I, O1, O2&gt;(IPipe&lt;I, O1&gt;, IPipe&lt;O1, O2&gt;)](../src/Core/Pipes/PipeExtensions.cs#L26)
```cs
public static IPipe<I, O2> Then<I, O1, O2>(this IPipe<I, O1> a, IPipe<O1, O2> b)
```

Composes the pipe with another pipe so that the output of the first pipe is passed as an input to the second pipe.

### [Then<I, O>(IPipe<I, O>, IPipe<O, O>, bool)](../src/Core/Pipes/PipeExtensions.cs#L32)
### [Then&lt;I, O&gt;(IPipe&lt;I, O&gt;, IPipe&lt;O, O&gt;, bool)](../src/Core/Pipes/PipeExtensions.cs#L32)
```cs
public static IPipe<I, O> Then<I, O>(this IPipe<I, O> a, IPipe<O, O> b, bool when)
```

Composes the pipe with another pipe so that the output of the first pipe is passed as an input to the second pipe.

### [Then<I, O1, O2>(IPipe<I, O1>, Func<O1, O2>)](../src/Core/Pipes/PipeExtensions.cs#L38)
### [Then&lt;I, O1, O2&gt;(IPipe&lt;I, O1&gt;, Func&lt;O1, O2&gt;)](../src/Core/Pipes/PipeExtensions.cs#L38)
```cs
public static IPipe<I, O2> Then<I, O1, O2>(this IPipe<I, O1> a, Func<O1, O2> map)
```

Constructs a new pipe that will apply the specified `select` function to the output of the current pipe.

### [Then<I, O>(IPipe<I, O>, Func<O, O>, bool)](../src/Core/Pipes/PipeExtensions.cs#L44)
### [Then&lt;I, O&gt;(IPipe&lt;I, O&gt;, Func&lt;O, O&gt;, bool)](../src/Core/Pipes/PipeExtensions.cs#L44)
```cs
public static IPipe<I, O> Then<I, O>(this IPipe<I, O> a, Func<O, O> map, bool when)
```

Constructs a new pipe that will apply the specified `select` function to the output of the current pipe.

### [ThenForEach<I, O1, O2>(IPipe<I, O1[]>, IPipe<O1, O2>)](../src/Core/Pipes/PipeExtensions.cs#L50)
### [ThenForEach&lt;I, O1, O2&gt;(IPipe&lt;I, O1[]&gt;, IPipe&lt;O1, O2&gt;)](../src/Core/Pipes/PipeExtensions.cs#L50)
```cs
public static IPipe<I, O2[]> ThenForEach<I, O1, O2>(this IPipe<I, O1[]> a, IPipe<O1, O2> b)
```

Constructs a new pipe that will apply the specified map pipe to the each element of the output of the current pipe.

### [Tee<I, O>(IPipe<I, O>, Action<O>)](../src/Core/Pipes/PipeExtensions.cs#L56)
### [Tee&lt;I, O&gt;(IPipe&lt;I, O&gt;, Action&lt;O&gt;)](../src/Core/Pipes/PipeExtensions.cs#L56)
```cs
public static IPipe<I, O> Tee<I, O>(this IPipe<I, O> a, Action<O> action)
```

Constructs a new pipe that will execute the specified action on the output.

### [Logged<I, O>(IPipe<I, O>, ILoggerFactory, string)](../src/Core/Pipes/PipeExtensions.cs#L62)
### [Logged&lt;I, O&gt;(IPipe&lt;I, O&gt;, ILoggerFactory, string)](../src/Core/Pipes/PipeExtensions.cs#L62)
```cs
public static IPipe<I, O> Logged<I, O>(this IPipe<I, O> self, ILoggerFactory factory, string message)
```

Logs the execution of the given pipe using the specified logger factory.

### [Logged<I, O>(IPipe<I, O>, ILoggerFactory, Func<I, string>)](../src/Core/Pipes/PipeExtensions.cs#L66)
### [Logged&lt;I, O&gt;(IPipe&lt;I, O&gt;, ILoggerFactory, Func&lt;I, string&gt;)](../src/Core/Pipes/PipeExtensions.cs#L66)
```cs
public static IPipe<I, O> Logged<I, O>(this IPipe<I, O> self, ILoggerFactory factory, Func<I, string> message)
```

Logs the execution of the given pipe using the specified logger factory.

### [Logged<I, O>(IPipe<I, O>, ILogger, string)](../src/Core/Pipes/PipeExtensions.cs#L72)
### [Logged&lt;I, O&gt;(IPipe&lt;I, O&gt;, ILogger, string)](../src/Core/Pipes/PipeExtensions.cs#L72)
```cs
public static IPipe<I, O> Logged<I, O>(this IPipe<I, O> self, ILogger logger, string message)
```

Logs the execution of the given pipe using the specified logger.

### [Logged<I, O>(IPipe<I, O>, ILogger, Func<I, string>)](../src/Core/Pipes/PipeExtensions.cs#L76)
### [Logged&lt;I, O&gt;(IPipe&lt;I, O&gt;, ILogger, Func&lt;I, string&gt;)](../src/Core/Pipes/PipeExtensions.cs#L76)
```cs
public static IPipe<I, O> Logged<I, O>(this IPipe<I, O> self, ILogger logger, Func<I, string> message)
```
Expand Down
2 changes: 1 addition & 1 deletion docs/Summary.Pipes.TeePipe{I,O}.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# [Summary.Pipes.TeePipe<I, O>](../src/Core/Pipes/TeePipe.cs#L6)
# [Summary.Pipes.TeePipe&lt;I, O&gt;](../src/Core/Pipes/TeePipe.cs#L6)
```cs
public class TeePipe<I, O> : IPipe<I, O>
```
Expand Down
2 changes: 1 addition & 1 deletion docs/Summary.Pipes.ThenForEach{I,O1,O2}.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# [Summary.Pipes.ThenForEach<I, O1, O2>](../src/Core/Pipes/ThenForEach.cs#L6)
# [Summary.Pipes.ThenForEach&lt;I, O1, O2&gt;](../src/Core/Pipes/ThenForEach.cs#L6)
```cs
public class ThenForEach<I, O1, O2> : IPipe<I, O2[]>
```
Expand Down
2 changes: 1 addition & 1 deletion docs/Summary.Pipes.ThenPipe{I,O1,O2}.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# [Summary.Pipes.ThenPipe<I, O1, O2>](../src/Core/Pipes/ThenPipe.cs#L6)
# [Summary.Pipes.ThenPipe&lt;I, O1, O2&gt;](../src/Core/Pipes/ThenPipe.cs#L6)
```cs
public class ThenPipe<I, O1, O2> : IPipe<I, O2>
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ public static class DocMemberExtensions
A set of extension methods for [`DocMember`](./Summary.DocMember.md).

## Methods
### [WithComment<T>(T, MemberDeclarationSyntax)](../src/Plugins/Roslyn/CSharp/Extensions/DocMemberExtensions.cs#L13)
### [WithComment&lt;T&gt;(T, MemberDeclarationSyntax)](../src/Plugins/Roslyn/CSharp/Extensions/DocMemberExtensions.cs#L13)
```cs
public static T WithComment<T>(this T self, MemberDeclarationSyntax syntax)
```
Expand Down
2 changes: 1 addition & 1 deletion docs/Summary.Samples.InheritDocBase.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ Calculates the sum.
#### Returns
Returns the sum of two values.

### [Sum<T>(byte, byte)](../src/Core/Samples/InheritDocSample.cs#L83)
### [Sum&lt;T&gt;(byte, byte)](../src/Core/Samples/InheritDocSample.cs#L83)
```cs
public byte Sum<T>(byte x, byte y)
```
Expand Down
2 changes: 1 addition & 1 deletion docs/Summary.Samples.Sample{T0,T1}.Child.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# [~~Summary.Samples.Sample<T0, T1>.Child~~](../src/Core/Samples/Sample.cs#L42)
# [~~Summary.Samples.Sample&lt;T0, T1&gt;.Child~~](../src/Core/Samples/Sample.cs#L42)
> [!WARNING]
> The type is deprecated.
Expand Down
Loading
Loading