Skip to content

Commit

Permalink
Escape only type names
Browse files Browse the repository at this point in the history
  • Loading branch information
joshua-light committed Dec 19, 2023
1 parent 307bed1 commit ddf8652
Show file tree
Hide file tree
Showing 38 changed files with 117 additions and 117 deletions.
20 changes: 10 additions & 10 deletions docs/Summary.Caching.CrefCache.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@ public static string AsCref(this string self)
Converts the given string into the format of `cref` attribute value.

#### Example
In the following example, the `"Some<T1, T2>"` string
In the following example, the `"Some<T1, T2>"` string
(which represents the name of some type)
is converted into `"Some{T1,T2}"` as if it was a value of a link
(e.g., &lt;see cref="Some{T1,T2}"&gt;):
(e.g., <see cref="Some{T1,T2}">):
```cs
var a = "Some&lt;T1, T2&gt;";
var a = "Some<T1, T2>";
var b = a.AsCref();
&lt;br/&gt;
<br/>
b.Should().Be("Some{T1,T2}");
```

Expand All @@ -34,14 +34,14 @@ Converts the given string into the format of `cref` attribute value
but also removes all generic parameter names.

#### Example
In the following example, the `"Some&lt;T1, T2&gt;"` string
In the following example, the `"Some<T1, T2>"` string
(which represents the name of some type)
is converted into `"Some{,}"`, the raw form of `cref` that can be used for comparisons
without involving generic type parameter names.
```cs
var a = "Some&lt;T1, T2&gt;";
var a = "Some<T1, T2>";
var b = a.AsCref();
&lt;br/&gt;
<br/>
b.Should().Be("Some{,}");
```

Expand All @@ -55,11 +55,11 @@ Converts the given string from the format of `cref` attribute value.
#### Example
In the following example, the `"Some{T1,T2}"` string
(which represents the name of some type in the `cref` format)
is converted into `"Some&lt;T1, T2&gt;` so that it can be displayed somewhere.
is converted into `"Some<T1, T2>` so that it can be displayed somewhere.
```cs
var a = "Some{T1,T2}";
var b = a.AsCref();
&lt;br/&gt;
b.Should().Be("Some&lt;T1, T2&gt;");
<br/>
b.Should().Be("Some<T1, T2>");
```

6 changes: 3 additions & 3 deletions docs/Summary.Cli.Logging.ConsoleLoggerFactory.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,12 @@ public void Dispose()

### [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&lt;TState&gt;(
public void Log<TState>(
LogLevel logLevel,
EventId eventId,
TState state,
Exception? exception,
Func&lt;TState, Exception?, string&gt; formatter)
Func<TState, Exception?, string> formatter)
```

### [IsEnabled(LogLevel)](../src/Cli/Logging/ConsoleLoggerFactory.cs#L49)
Expand All @@ -34,7 +34,7 @@ public bool IsEnabled(LogLevel logLevel)

### [BeginScope&lt;TState&gt;(TState)](../src/Cli/Logging/ConsoleLoggerFactory.cs#L51)
```cs
public IDisposable? BeginScope&lt;TState&gt;(TState state)
public IDisposable? BeginScope<TState>(TState state)
```

### [CreateLogger(string)](../src/Cli/Logging/ConsoleLoggerFactory.cs#L63)
Expand Down
10 changes: 5 additions & 5 deletions docs/Summary.DocComment.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ The sequence of nodes this comment consists of (e.g. `summary`, `remarks`, etc.)
public DocCommentElement? Param(string name)
```

A nested `&lt;param&gt;` documentation element that has the specified name.
A nested `<param>` documentation element that has the specified name.

#### Parameters
- `name`: The name of the parameter to search inside the comment.
Expand All @@ -37,7 +37,7 @@ A nested `&lt;param&gt;` documentation element that has the specified name.
public DocCommentElement? TypeParam(string name)
```

A nested `&lt;typeparam&gt;` documentation element that has the specified name.
A nested `<typeparam>` documentation element that has the specified name.

#### Parameters
- `name`: The name of the parameter to search inside the comment.
Expand Down Expand Up @@ -65,7 +65,7 @@ A nested documentation element that has the specified name (e.g. `summary`, `rem

### [Element(Func&lt;DocCommentElement, bool&gt;)](../src/Core/DocComment.cs#L47)
```cs
public DocCommentElement? Element(Func&lt;DocCommentElement, bool&gt; p)
public DocCommentElement? Element(Func<DocCommentElement, bool> p)
```

A nested documentation element that matches the specified predicate `p`.
Expand All @@ -75,7 +75,7 @@ A nested documentation element that matches the specified predicate `p`.

### [Elements(string)](../src/Core/DocComment.cs#L54)
```cs
public IEnumerable&lt;DocCommentElement&gt; Elements(string tag)
public IEnumerable<DocCommentElement> Elements(string tag)
```

A sequence of nested documentation elements that have the specified name (e.g. `summary`, `remarks`, etc.).
Expand All @@ -85,7 +85,7 @@ A sequence of nested documentation elements that have the specified name (e.g. `

### [Elements(Func&lt;DocCommentElement, bool&gt;)](../src/Core/DocComment.cs#L61)
```cs
public IEnumerable&lt;DocCommentElement&gt; Elements(Func&lt;DocCommentElement, bool&gt; p)
public IEnumerable<DocCommentElement> Elements(Func<DocCommentElement, bool> p)
```

A sequence of nested documentation elements that match the specified predicate.
Expand Down
2 changes: 1 addition & 1 deletion docs/Summary.DocCommentInheritDoc.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ public record DocCommentInheritDoc(string? Cref) : DocCommentNode
```

A [`DocCommentNode`](./Summary.DocCommentNode.md) that inherits documentation from another member
(`&lt;inheritdoc&gt;`).
(`<inheritdoc>`).

## Properties
### [Cref](../src/Core/DocCommentInheritDoc.cs#L8)
Expand Down
2 changes: 1 addition & 1 deletion docs/Summary.DocCommentLink.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
public record DocCommentLink(DocMember? Member, string Value) : DocCommentNode
```

A [`DocCommentNode`](./Summary.DocCommentNode.md) that represents the link to other member (e.g. `&lt;see cref="SomeMember"/&gt;`).
A [`DocCommentNode`](./Summary.DocCommentNode.md) that represents the link to other member (e.g. `<see cref="SomeMember"/>`).

## Properties
### [Member](../src/Core/DocCommentLink.cs#L9)
Expand Down
2 changes: 1 addition & 1 deletion docs/Summary.DocCommentParamRef.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ public record DocCommentParamRef(string Value) : DocCommentNode
```

A [`DocCommentNode`](./Summary.DocCommentNode.md) that represents the reference to a parameter
(`&lt;paramref&gt;`, `&lt;typeparamref&gt;`).
(`<paramref>`, `<typeparamref>`).

## Properties
### [Value](../src/Core/DocCommentParamRef.cs#L8)
Expand Down
4 changes: 2 additions & 2 deletions docs/Summary.DocMethod.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,13 @@ public string Signature { get; }
```

The full signature of the method that includes both type parameters and regular parameters
(e.g., `"Method&lt;T1, T2&gt;(int, short)"`).
(e.g., `"Method<T1, T2>(int, short)"`).

### [FullyQualifiedSignature](../src/Core/DocMethod.cs#L39)
```cs
public string FullyQualifiedSignature { get; }
```

The full signature of the method that includes both type parameters and regular parameters
(e.g., `"Method&lt;T1, T2&gt;(int, short)"`).
(e.g., `"Method<T1, T2>(int, short)"`).

2 changes: 1 addition & 1 deletion docs/Summary.DocParam.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,5 @@ The name of the parameter.
public DocCommentElement? Comment(DocMember parent)
```

The comment of the parameter (i.e., `&lt;param&gt;` tag).
The comment of the parameter (i.e., `<param>` tag).

2 changes: 1 addition & 1 deletion docs/Summary.DocType.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
public record DocType(string Name, DocType[] TypeParams, string? FullyQualifiedName = null)
```

A simple type (e.g. `int`, `string`, `List&lt;int&gt;`, etc.).
A simple type (e.g. `int`, `string`, `List<int>`, etc.).

## Properties
### [FullName](../src/Core/DocType.cs#L16)
Expand Down
4 changes: 2 additions & 2 deletions docs/Summary.DocTypeDeclaration.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,15 +37,15 @@ Whether this type declaration is a record declaration.

### [AllMembers](../src/Core/DocTypeDeclaration.cs#L35)
```cs
public IEnumerable&lt;DocMember&gt; AllMembers { get; }
public IEnumerable<DocMember> AllMembers { get; }
```

All nested members (including children of children) of this type declaration.

## Methods
### [MembersOfType(DocMember)](../src/Core/DocTypeDeclaration.cs#L41)
```cs
public IEnumerable&lt;DocMember&gt; MembersOfType(DocMember member)
public IEnumerable<DocMember> MembersOfType(DocMember member)
```

A sequence of members of this type declaration that has the same type as the specified one.
Expand Down
2 changes: 1 addition & 1 deletion docs/Summary.DocTypeParam.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,5 @@ The name of the parameter.
public DocCommentElement? Comment(DocMember parent)
```

The comment of the parameter (i.e., `&lt;typeparam&gt;` tag).
The comment of the parameter (i.e., `<typeparam>` tag).

6 changes: 3 additions & 3 deletions docs/Summary.Markdown.RenderMarkdownPipe.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# [Summary.Markdown.RenderMarkdownPipe](../src/Plugins/Markdown/RenderMarkdownPipe.cs#L9)
```cs
public class RenderMarkdownPipe : IPipe&lt;Doc, Md[]&gt;
public class RenderMarkdownPipe : IPipe<Doc, Md[]>
```

A [`IPipe&lt;I, O&gt;`](./Summary.Pipes.IPipe{I,O}.md) that renders generated document into the sequence of Markdown files.
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#L11)
```cs
public Task&lt;Md[]&gt; Run(Doc doc)
public Task<Md[]> Run(Doc doc)
```

4 changes: 2 additions & 2 deletions docs/Summary.Pipelines.FilteringExtensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,14 +47,14 @@ pipeline.IncludeOnly(AccessModifier.Internal);

### [WithAccess(SummaryPipeline, Func&lt;AccessModifier, bool&gt;)](../src/Core/Pipelines/SummaryPipelineFilteringExtensions.cs#L50)
```cs
public static SummaryPipeline WithAccess(this SummaryPipeline self, Func&lt;AccessModifier, bool&gt; p)
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&lt;Doc, Doc&gt;)](../src/Core/Pipelines/SummaryPipelineFilteringExtensions.cs#L67)
```cs
public static SummaryPipeline UseFilter(this SummaryPipeline self, IPipe&lt;Doc, Doc&gt; filter)
public static SummaryPipeline UseFilter(this SummaryPipeline self, IPipe<Doc, Doc> filter)
```

Adds the given filter into the pipeline.
Expand Down
14 changes: 7 additions & 7 deletions docs/Summary.Pipelines.SummaryPipeline.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ public class SummaryPipeline
A plain Summary pipeline that should be used in simple cases.

_By default, this pipeline supports one parser pipe and one renderer pipe._
_&lt;br /&gt;_
_<br />_
_Parser pipe should extract [`Doc`](./Summary.Doc.md) from some source (e.g., file system), while_
_renderer pipe should render the parsed [`Doc`](./Summary.Doc.md) into some format (e.g., Markdown)_
_and save it somewhere (e.g., file system)._
Expand All @@ -21,7 +21,7 @@ The factory that provides logger implementations.

### [Filters](../src/Core/Pipelines/SummaryPipeline.cs#L63)
```cs
public List&lt;IPipe&lt;Doc, Doc&gt;&gt; Filters { get; }
public List<IPipe<Doc, Doc>> Filters { get; }
```

The list of all filters applied after the document is parsed.
Expand All @@ -38,35 +38,35 @@ Specifies the logger factory that will be used to create loggers for the pipelin

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

Customizes the default pipeline options using the specified delegate.

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

Specifies the custom parser with logging support for this pipeline.

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

Specifies the custom parser for this pipeline.

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

Specifies the custom renderer for this pipeline.

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

Specifies the custom renderer for this pipeline.
Expand Down
4 changes: 2 additions & 2 deletions docs/Summary.Pipes.Filters.FilterMemberPipe.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# [Summary.Pipes.Filters.FilterMemberPipe](../src/Core/Pipes/Filters/FilterMemberPipe.cs#L7)
```cs
public class FilterMemberPipe : IPipe&lt;Doc, Doc&gt;
public class FilterMemberPipe : IPipe<Doc, Doc>
```

A simple pipe that filters all members inside the document using the specified predicate
Expand All @@ -9,7 +9,7 @@ and then applies the given map function on them.
## Methods
### [Run(Doc)](../src/Core/Pipes/Filters/FilterMemberPipe.cs#L12)
```cs
public Task&lt;Doc&gt; Run(Doc input)
public Task<Doc> Run(Doc input)
```

Asynchronously processes the specified input and returns the output.
Expand Down
6 changes: 3 additions & 3 deletions docs/Summary.Pipes.FoldPipe{O}.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# [Summary.Pipes.FoldPipe&lt;O&gt;](../src/Core/Pipes/FoldPipe.cs#L6)
```cs
public class FoldPipe&lt;O&gt; : IPipe&lt;O[], O&gt;
public class FoldPipe<O> : IPipe<O[], O>
```

A [`IPipe&lt;I, O&gt;`](./Summary.Pipes.IPipe{I,O}.md) that aggregates the result of the specified pipe.
A [`IPipe<I, O>`](./Summary.Pipes.IPipe{I,O}.md) that aggregates the result of the specified pipe.

## Methods
### [Run(O[])](../src/Core/Pipes/FoldPipe.cs#L9)
```cs
public Task&lt;O&gt; Run(O[] input)
public Task<O> Run(O[] input)
```

Asynchronously processes the specified input and returns the output.
Expand Down
6 changes: 3 additions & 3 deletions docs/Summary.Pipes.FuncPipe{I,O}.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# [Summary.Pipes.FuncPipe&lt;I, O&gt;](../src/Core/Pipes/FuncPipe.cs#L6)
```cs
public class FuncPipe&lt;I, O&gt; : IPipe&lt;I, O&gt;
public class FuncPipe<I, O> : IPipe<I, O>
```

A [`IPipe&lt;I, O&gt;`](./Summary.Pipes.IPipe{I,O}.md) that wraps &lt;u&gt;`Func&lt;I, O&gt;`&lt;/u&gt;.
A [`IPipe<I, O>`](./Summary.Pipes.IPipe{I,O}.md) that wraps <u>`Func<I, O>`</u>.

## Methods
### [Run(I)](../src/Core/Pipes/FuncPipe.cs#L21)
```cs
public Task&lt;O&gt; Run(I input)
public Task<O> Run(I input)
```

Asynchronously processes the specified input and returns the output.
Expand Down
4 changes: 2 additions & 2 deletions docs/Summary.Pipes.IO.CleanupDirPipe{I}.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# [Summary.Pipes.IO.CleanupDirPipe&lt;I&gt;](../src/Core/Pipes/IO/CleanupDirPipe.cs#L6)
```cs
public class CleanupDirPipe&lt;I&gt; : IPipe&lt;I, I&gt;
public class CleanupDirPipe<I> : IPipe<I, I>
```

Cleans up a given directory by deleting and re-creating it.

## Methods
### [Run(I)](../src/Core/Pipes/IO/CleanupDirPipe.cs#L9)
```cs
public Task&lt;I&gt; Run(I input)
public Task<I> Run(I input)
```

Asynchronously processes the specified input and returns the output.
Expand Down
6 changes: 3 additions & 3 deletions docs/Summary.Pipes.IO.SavePipe{I}.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# [Summary.Pipes.IO.SavePipe&lt;I&gt;](../src/Core/Pipes/IO/SavePipe.cs#L6)
```cs
public class SavePipe&lt;I&gt; : IPipe&lt;I, Unit&gt;
public class SavePipe<I> : IPipe<I, Unit>
```

A [`IPipe&lt;I, O&gt;`](./Summary.Pipes.IPipe{I,O}.md) that saves the input to the file.
A [`IPipe<I, O>`](./Summary.Pipes.IPipe{I,O}.md) that saves the input to the file.

## Methods
### [Run(I)](../src/Core/Pipes/IO/SavePipe.cs#L9)
```cs
public async Task&lt;Unit&gt; Run(I input)
public async Task<Unit> Run(I input)
```

Asynchronously processes the specified input and returns the output.
Expand Down
Loading

0 comments on commit ddf8652

Please sign in to comment.