From b228539a18e4bff30c9af3c3ff4a929673c7feb5 Mon Sep 17 00:00:00 2001 From: Kostia Ohulchanskyi Date: Sun, 10 Dec 2023 00:11:35 +0000 Subject: [PATCH] Increment line number --- docs/CleanupDirPipe{I}.md | 4 +-- docs/ConsoleLoggerFactory.md | 18 ++++++------ docs/Doc.md | 10 +++---- docs/DocComment.md | 16 +++++------ docs/DocCommentElement.md | 8 +++--- docs/DocCommentElementAttribute.md | 6 ++-- docs/DocCommentInheritDoc.md | 4 +-- docs/DocCommentLink.md | 4 +-- docs/DocCommentLiteral.md | 8 +++--- docs/DocCommentNode.md | 2 +- docs/DocCommentParamRef.md | 4 +-- docs/DocDeprecation.md | 6 ++-- docs/DocExtensions.md | 6 ++-- docs/DocField.md | 4 +-- docs/DocIndexer.md | 4 +-- docs/DocLocation.md | 8 +++--- docs/DocMember.md | 22 +++++++-------- docs/DocMethod.md | 12 ++++---- docs/DocParam.md | 8 +++--- docs/DocProperty.md | 8 +++--- docs/DocType.md | 8 +++--- docs/DocTypeDeclaration.md | 18 ++++++------ docs/DocTypeParam.md | 6 ++-- docs/Extensions.md | 6 ++-- docs/FilterMemberPipe.md | 4 +-- docs/FoldPipe{O}.md | 4 +-- docs/FuncPipe{I,O}.md | 4 +-- docs/GlobalDelegate.md | 2 +- docs/IInheritDocBase.md | 2 +- docs/IPipe{I,O}.md | 4 +-- docs/InheritDocBase.md | 34 +++++++++++------------ docs/InheritDocRecordBase.md | 4 +-- docs/InheritDocRecordBase_Child.md | 6 ++-- docs/InheritDoc_Child.md | 10 +++---- docs/InheritDoc_Child2.md | 22 +++++++-------- docs/InheritDoc_Child_OverrideSummary.md | 2 +- docs/InheritDoc_Child_OverrideSummary2.md | 2 +- docs/InheritDoc_CrefBase.md | 8 +++--- docs/InheritDoc_CrefBase_Child.md | 2 +- docs/InheritDoc_InterfaceChild.md | 2 +- docs/InlineInheritDocPipe.md | 4 +-- docs/LoggedPipe{I,O}.md | 4 +-- docs/MarkdownPipelineExtensions.md | 4 +-- docs/MarkdownTests.md | 8 +++--- docs/Md.md | 6 ++-- docs/ParseDocPipe.md | 4 +-- docs/ParseSyntaxTreePipe.md | 4 +-- docs/PipeExtensions.md | 26 ++++++++--------- docs/PipesTests.md | 10 +++---- docs/RenderMarkdownPipe.md | 4 +-- docs/RoslynParserTests.md | 8 +++--- docs/RoslynPipelineExtensions.md | 6 ++-- docs/Sample{T0,T1}.Child.md | 4 +-- docs/Sample{T0,T1}.md | 30 ++++++++++---------- docs/SavePipe{I}.md | 4 +-- docs/ScanPipe.md | 4 +-- docs/Source.md | 8 +++--- docs/SummaryPipeline.Options.md | 6 ++-- docs/SummaryPipeline.md | 20 ++++++------- docs/SummaryPipelineExtensions.md | 12 ++++---- docs/TeePipe{I,O}.md | 4 +-- docs/ThenForEach{I,O1,O2}.md | 4 +-- docs/ThenPipe{I,O1,O2}.md | 4 +-- docs/Unit.md | 4 +-- src/Plugins/Markdown/MdRenderer.cs | 2 +- 65 files changed, 253 insertions(+), 253 deletions(-) diff --git a/docs/CleanupDirPipe{I}.md b/docs/CleanupDirPipe{I}.md index 9ca73af..94799ae 100644 --- a/docs/CleanupDirPipe{I}.md +++ b/docs/CleanupDirPipe{I}.md @@ -1,4 +1,4 @@ -# [Summary.Pipes.IO.CleanupDirPipe](../src/Core/Pipes/IO/CleanupDirPipe.cs#L5) +# [Summary.Pipes.IO.CleanupDirPipe](../src/Core/Pipes/IO/CleanupDirPipe.cs#L6) ```cs public class CleanupDirPipe : IPipe ``` @@ -6,7 +6,7 @@ public class CleanupDirPipe : IPipe Cleans up a given directory by deleting and re-creating it. ## Methods -### [Run(I)](../src/Core/Pipes/IO/CleanupDirPipe.cs#L7) +### [Run(I)](../src/Core/Pipes/IO/CleanupDirPipe.cs#L8) ```cs public Task Run(I input) ``` diff --git a/docs/ConsoleLoggerFactory.md b/docs/ConsoleLoggerFactory.md index fe0183a..0c8a794 100644 --- a/docs/ConsoleLoggerFactory.md +++ b/docs/ConsoleLoggerFactory.md @@ -1,4 +1,4 @@ -# [Summary.Cli.Logging.ConsoleLoggerFactory](../src/Cli/Logging/ConsoleLoggerFactory.cs#L8) +# [Summary.Cli.Logging.ConsoleLoggerFactory](../src/Cli/Logging/ConsoleLoggerFactory.cs#L9) ```cs public class ConsoleLoggerFactory : ILoggerFactory ``` @@ -6,18 +6,18 @@ public class ConsoleLoggerFactory : ILoggerFactory A simple factory for console loggers that format messages in the Summary CLI way. ## Fields -### [Instance](../src/Cli/Logging/ConsoleLoggerFactory.cs#L36) +### [Instance](../src/Cli/Logging/ConsoleLoggerFactory.cs#L37) ```cs public static readonly ILogger Instance ``` ## Methods -### [Dispose()](../src/Cli/Logging/ConsoleLoggerFactory.cs#L26) +### [Dispose()](../src/Cli/Logging/ConsoleLoggerFactory.cs#L27) ```cs public void Dispose() ``` -### [Log(LogLevel, EventId, TState, Exception?, Func, string>)](../src/Cli/Logging/ConsoleLoggerFactory.cs#L40) +### [Log(LogLevel, EventId, TState, Exception?, Func, string>)](../src/Cli/Logging/ConsoleLoggerFactory.cs#L41) ```cs public void Log( LogLevel logLevel, @@ -27,27 +27,27 @@ public void Log( Func formatter) ``` -### [IsEnabled(LogLevel)](../src/Cli/Logging/ConsoleLoggerFactory.cs#L48) +### [IsEnabled(LogLevel)](../src/Cli/Logging/ConsoleLoggerFactory.cs#L49) ```cs public bool IsEnabled(LogLevel logLevel) ``` -### [BeginScope(TState)](../src/Cli/Logging/ConsoleLoggerFactory.cs#L50) +### [BeginScope(TState)](../src/Cli/Logging/ConsoleLoggerFactory.cs#L51) ```cs public IDisposable? BeginScope(TState state) ``` -### [CreateLogger(string)](../src/Cli/Logging/ConsoleLoggerFactory.cs#L62) +### [CreateLogger(string)](../src/Cli/Logging/ConsoleLoggerFactory.cs#L63) ```cs public ILogger CreateLogger(string categoryName) ``` -### [AddProvider(ILoggerProvider)](../src/Cli/Logging/ConsoleLoggerFactory.cs#L64) +### [AddProvider(ILoggerProvider)](../src/Cli/Logging/ConsoleLoggerFactory.cs#L65) ```cs public void AddProvider(ILoggerProvider provider) ``` -### [Dispose()](../src/Cli/Logging/ConsoleLoggerFactory.cs#L68) +### [Dispose()](../src/Cli/Logging/ConsoleLoggerFactory.cs#L69) ```cs public void Dispose() ``` diff --git a/docs/Doc.md b/docs/Doc.md index 1791211..dbcc798 100644 --- a/docs/Doc.md +++ b/docs/Doc.md @@ -1,4 +1,4 @@ -# [Summary.Doc](../src/Core/Doc.cs#L6) +# [Summary.Doc](../src/Core/Doc.cs#L7) ```cs public record Doc(DocMember[] Members) ``` @@ -6,7 +6,7 @@ public record Doc(DocMember[] Members) A document parsed from the source code or an assembly. ## Fields -### [Empty](../src/Core/Doc.cs#L11) +### [Empty](../src/Core/Doc.cs#L12) ```cs public static readonly Doc Empty ``` @@ -14,7 +14,7 @@ public static readonly Doc Empty An empty document. ## Properties -### [Members](../src/Core/Doc.cs#L6) +### [Members](../src/Core/Doc.cs#L7) ```cs public DocMember[] Members { get; } ``` @@ -22,7 +22,7 @@ public DocMember[] Members { get; } The sequence of members this doc contains. ## Methods -### [Merge(Doc, Doc)](../src/Core/Doc.cs#L18) +### [Merge(Doc, Doc)](../src/Core/Doc.cs#L19) ```cs public static Doc Merge(Doc a, Doc b) ``` @@ -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?)](../src/Core/Doc.cs#L23) +### [Declaration(DocType?)](../src/Core/Doc.cs#L24) ```cs public DocTypeDeclaration? Declaration(DocType? type) ``` diff --git a/docs/DocComment.md b/docs/DocComment.md index 9f1423d..74d23b4 100644 --- a/docs/DocComment.md +++ b/docs/DocComment.md @@ -1,4 +1,4 @@ -# [Summary.DocComment](../src/Core/DocComment.cs#L6) +# [Summary.DocComment](../src/Core/DocComment.cs#L7) ```cs public record DocComment(DocCommentNode[] Nodes) ``` @@ -6,7 +6,7 @@ public record DocComment(DocCommentNode[] Nodes) A documentation comment parsed from the source code. ## Fields -### [Empty](../src/Core/DocComment.cs#L11) +### [Empty](../src/Core/DocComment.cs#L12) ```cs public static readonly DocComment Empty ``` @@ -14,7 +14,7 @@ public static readonly DocComment Empty An empty documentation comment. ## Properties -### [Nodes](../src/Core/DocComment.cs#L6) +### [Nodes](../src/Core/DocComment.cs#L7) ```cs public DocCommentNode[] Nodes { get; } ``` @@ -22,7 +22,7 @@ public DocCommentNode[] Nodes { get; } The sequence of nodes this comment consists of (e.g. `summary`, `remarks`, etc.). ## Methods -### [Param(string)](../src/Core/DocComment.cs#L17) +### [Param(string)](../src/Core/DocComment.cs#L18) ```cs public DocCommentElement? Param(string name) ``` @@ -32,7 +32,7 @@ A nested documentation element that has the specified name. #### Parameters - `name`: The name of the parameter to search inside the comment. -### [TypeParam(string)](../src/Core/DocComment.cs#L24) +### [TypeParam(string)](../src/Core/DocComment.cs#L25) ```cs public DocCommentElement? TypeParam(string name) ``` @@ -42,7 +42,7 @@ A nested documentation element that has the specified name. #### Parameters - `name`: The name of the parameter to search inside the comment. -### [Element(string, string)](../src/Core/DocComment.cs#L32) +### [Element(string, string)](../src/Core/DocComment.cs#L33) ```cs public DocCommentElement? Element(string tag, string name) ``` @@ -53,7 +53,7 @@ A nested documentation element that has the specified name (e.g. `summary`, `rem - `tag`: The name of the element tag to search inside the comment. - `name`: The value of the `name` attribute of the tag. -### [Element(string)](../src/Core/DocComment.cs#L39) +### [Element(string)](../src/Core/DocComment.cs#L40) ```cs public DocCommentElement? Element(string tag) ``` @@ -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)](../src/Core/DocComment.cs#L46) +### [Element(Func)](../src/Core/DocComment.cs#L47) ```cs public DocCommentElement? Element(Func p) ``` diff --git a/docs/DocCommentElement.md b/docs/DocCommentElement.md index f987116..8a1725f 100644 --- a/docs/DocCommentElement.md +++ b/docs/DocCommentElement.md @@ -1,4 +1,4 @@ -# [Summary.DocCommentElement](../src/Core/DocCommentElement.cs#L10) +# [Summary.DocCommentElement](../src/Core/DocCommentElement.cs#L11) ```cs public record DocCommentElement(string Name, DocCommentElementAttribute[] Attributes, DocCommentNode[] Nodes) : DocCommentNode ``` @@ -8,19 +8,19 @@ A [`DocCommentNode`](./DocCommentNode.md) that represents a compound element (e. _Each element can contain simple text as well as other elements._ ## Properties -### [Name](../src/Core/DocCommentElement.cs#L10) +### [Name](../src/Core/DocCommentElement.cs#L11) ```cs public string Name { get; } ``` The name of the element (e.g. `remarks`, `summary`, `example`). -### [Attributes](../src/Core/DocCommentElement.cs#L10) +### [Attributes](../src/Core/DocCommentElement.cs#L11) ```cs public DocCommentElementAttribute[] Attributes { get; } ``` -### [Nodes](../src/Core/DocCommentElement.cs#L10) +### [Nodes](../src/Core/DocCommentElement.cs#L11) ```cs public DocCommentNode[] Nodes { get; } ``` diff --git a/docs/DocCommentElementAttribute.md b/docs/DocCommentElementAttribute.md index 0cc4032..bca0cca 100644 --- a/docs/DocCommentElementAttribute.md +++ b/docs/DocCommentElementAttribute.md @@ -1,4 +1,4 @@ -# [Summary.DocCommentElementAttribute](../src/Core/DocCommentElementAttribute.cs#L7) +# [Summary.DocCommentElementAttribute](../src/Core/DocCommentElementAttribute.cs#L8) ```cs public record DocCommentElementAttribute(string Name, string Value) ``` @@ -6,14 +6,14 @@ public record DocCommentElementAttribute(string Name, string Value) An XML-documentation attribute (e.g. `name` in `param`, etc.). ## Properties -### [Name](../src/Core/DocCommentElementAttribute.cs#L7) +### [Name](../src/Core/DocCommentElementAttribute.cs#L8) ```cs public string Name { get; } ``` The name of the attribute (e.g. `name`, `cref`, etc.) -### [Value](../src/Core/DocCommentElementAttribute.cs#L7) +### [Value](../src/Core/DocCommentElementAttribute.cs#L8) ```cs public string Value { get; } ``` diff --git a/docs/DocCommentInheritDoc.md b/docs/DocCommentInheritDoc.md index 1dfcc47..da014f0 100644 --- a/docs/DocCommentInheritDoc.md +++ b/docs/DocCommentInheritDoc.md @@ -1,4 +1,4 @@ -# [Summary.DocCommentInheritDoc](../src/Core/DocCommentInheritDoc.cs#L7) +# [Summary.DocCommentInheritDoc](../src/Core/DocCommentInheritDoc.cs#L8) ```cs public record DocCommentInheritDoc(string? Cref) : DocCommentNode ``` @@ -7,7 +7,7 @@ A [`DocCommentNode`](./DocCommentNode.md) that inherits documentation from anoth (``). ## Properties -### [Cref](../src/Core/DocCommentInheritDoc.cs#L7) +### [Cref](../src/Core/DocCommentInheritDoc.cs#L8) ```cs public string? Cref { get; } ``` diff --git a/docs/DocCommentLink.md b/docs/DocCommentLink.md index 73b32fb..7373b04 100644 --- a/docs/DocCommentLink.md +++ b/docs/DocCommentLink.md @@ -1,4 +1,4 @@ -# [Summary.DocCommentLink](../src/Core/DocCommentLink.cs#L7) +# [Summary.DocCommentLink](../src/Core/DocCommentLink.cs#L8) ```cs public record DocCommentLink(string Value) : DocCommentNode ``` @@ -6,7 +6,7 @@ public record DocCommentLink(string Value) : DocCommentNode A [`DocCommentNode`](./DocCommentNode.md) that represents the link to other member (e.g. ``). ## Properties -### [Value](../src/Core/DocCommentLink.cs#L7) +### [Value](../src/Core/DocCommentLink.cs#L8) ```cs public string Value { get; } ``` diff --git a/docs/DocCommentLiteral.md b/docs/DocCommentLiteral.md index 6e4f8fe..3c751a8 100644 --- a/docs/DocCommentLiteral.md +++ b/docs/DocCommentLiteral.md @@ -1,4 +1,4 @@ -# [Summary.DocCommentLiteral](../src/Core/DocCommentLiteral.cs#L14) +# [Summary.DocCommentLiteral](../src/Core/DocCommentLiteral.cs#L15) ```cs public record DocCommentLiteral(string Value, string LeadingTrivia = "") : DocCommentNode ``` @@ -8,14 +8,14 @@ A [`DocCommentNode`](./DocCommentNode.md) that represents a literal value (e.g. _Literals are simple tokens that are parsed as text._ ## Properties -### [Value](../src/Core/DocCommentLiteral.cs#L14) +### [Value](../src/Core/DocCommentLiteral.cs#L15) ```cs public string Value { get; } ``` The value of the literal. -### [LeadingTrivia](../src/Core/DocCommentLiteral.cs#L14) +### [LeadingTrivia](../src/Core/DocCommentLiteral.cs#L15) ```cs public string LeadingTrivia { get; } ``` @@ -23,7 +23,7 @@ public string LeadingTrivia { get; } The leading trivia of the literal that is not included in the `Value`(i.e. space characters, newlines). ## Methods -### [New(string)](../src/Core/DocCommentLiteral.cs#L19) +### [New(string)](../src/Core/DocCommentLiteral.cs#L20) ```cs public static DocCommentLiteral New(string value) ``` diff --git a/docs/DocCommentNode.md b/docs/DocCommentNode.md index d4a3b30..b3ca8ee 100644 --- a/docs/DocCommentNode.md +++ b/docs/DocCommentNode.md @@ -1,4 +1,4 @@ -# [Summary.DocCommentNode](../src/Core/DocCommentNode.cs#L8) +# [Summary.DocCommentNode](../src/Core/DocCommentNode.cs#L9) ```cs public abstract record DocCommentNode ``` diff --git a/docs/DocCommentParamRef.md b/docs/DocCommentParamRef.md index 983e037..afcc335 100644 --- a/docs/DocCommentParamRef.md +++ b/docs/DocCommentParamRef.md @@ -1,4 +1,4 @@ -# [Summary.DocCommentParamRef](../src/Core/DocCommentParamRef.cs#L6) +# [Summary.DocCommentParamRef](../src/Core/DocCommentParamRef.cs#L7) ```cs public record DocCommentParamRef(string Value) : DocCommentNode ``` @@ -6,7 +6,7 @@ public record DocCommentParamRef(string Value) : DocCommentNode A [`DocCommentNode`](./DocCommentNode.md) that represents the reference to a parameter (``, ``). ## Properties -### [Value](../src/Core/DocCommentParamRef.cs#L6) +### [Value](../src/Core/DocCommentParamRef.cs#L7) ```cs public string Value { get; } ``` diff --git a/docs/DocDeprecation.md b/docs/DocDeprecation.md index 49f0d9b..a405b9c 100644 --- a/docs/DocDeprecation.md +++ b/docs/DocDeprecation.md @@ -1,4 +1,4 @@ -# [Summary.DocDeprecation](../src/Core/DocDeprecation.cs#L5) +# [Summary.DocDeprecation](../src/Core/DocDeprecation.cs#L6) ```cs public record DocDeprecation ``` @@ -6,14 +6,14 @@ public record DocDeprecation Contains deprecation information (e.g. the warning message). ## Properties -### [Message](../src/Core/DocDeprecation.cs#L10) +### [Message](../src/Core/DocDeprecation.cs#L11) ```cs public string? Message { get; init; } ``` The deprecation warning message. -### [Error](../src/Core/DocDeprecation.cs#L15) +### [Error](../src/Core/DocDeprecation.cs#L16) ```cs public bool Error { get; init; } ``` diff --git a/docs/DocExtensions.md b/docs/DocExtensions.md index 30df8a5..2e3badb 100644 --- a/docs/DocExtensions.md +++ b/docs/DocExtensions.md @@ -1,4 +1,4 @@ -# [Summary.DocExtensions](../src/Core/DocExtensions.cs#L7) +# [Summary.DocExtensions](../src/Core/DocExtensions.cs#L8) ```cs public static class DocExtensions ``` @@ -6,14 +6,14 @@ public static class DocExtensions Extension methods for different documentation model related types. ## Methods -### [IsSpace(DocCommentNode)](../src/Core/DocExtensions.cs#L12) +### [IsSpace(DocCommentNode)](../src/Core/DocExtensions.cs#L13) ```cs public static bool IsSpace(this DocCommentNode self) ``` Whether the given documentation comment node represents a space character. -### [IsNewLine(DocCommentNode)](../src/Core/DocExtensions.cs#L18) +### [IsNewLine(DocCommentNode)](../src/Core/DocExtensions.cs#L19) ```cs public static bool IsNewLine(this DocCommentNode self) ``` diff --git a/docs/DocField.md b/docs/DocField.md index 90c4aa0..3836678 100644 --- a/docs/DocField.md +++ b/docs/DocField.md @@ -1,4 +1,4 @@ -# [Summary.DocField](../src/Core/DocField.cs#L5) +# [Summary.DocField](../src/Core/DocField.cs#L6) ```cs public record DocField : DocMember ``` @@ -6,7 +6,7 @@ public record DocField : DocMember A [`DocMember`](./DocMember.md) that represents a documented field in the parsed source code. ## Properties -### [Type](../src/Core/DocField.cs#L10) +### [Type](../src/Core/DocField.cs#L11) ```cs public required DocType Type { get; init; } ``` diff --git a/docs/DocIndexer.md b/docs/DocIndexer.md index c6b65da..0d8a821 100644 --- a/docs/DocIndexer.md +++ b/docs/DocIndexer.md @@ -1,4 +1,4 @@ -# [Summary.DocIndexer](../src/Core/DocIndexer.cs#L5) +# [Summary.DocIndexer](../src/Core/DocIndexer.cs#L6) ```cs public record DocIndexer : DocProperty ``` @@ -6,7 +6,7 @@ public record DocIndexer : DocProperty A [`DocProperty`](./DocProperty.md) that represents an indexer. ## Properties -### [Params](../src/Core/DocIndexer.cs#L10) +### [Params](../src/Core/DocIndexer.cs#L11) ```cs public required DocParam[] Params { get; init; } ``` diff --git a/docs/DocLocation.md b/docs/DocLocation.md index 6980e2a..75dd9ec 100644 --- a/docs/DocLocation.md +++ b/docs/DocLocation.md @@ -1,4 +1,4 @@ -# [Summary.DocLocation](../src/Core/DocLocation.cs#L5) +# [Summary.DocLocation](../src/Core/DocLocation.cs#L6) ```cs public record DocLocation ``` @@ -6,21 +6,21 @@ public record DocLocation The location of the documented member. ## Properties -### [Path](../src/Core/DocLocation.cs#L10) +### [Path](../src/Core/DocLocation.cs#L11) ```cs public required string Path { get; init; } ``` The path to the file where the member is located. -### [Start](../src/Core/DocLocation.cs#L15) +### [Start](../src/Core/DocLocation.cs#L16) ```cs public required (int Line, int? Column) Start { get; init; } ``` The location where the member starts. -### [End](../src/Core/DocLocation.cs#L20) +### [End](../src/Core/DocLocation.cs#L21) ```cs public (int Line, int? Column)? End { get; init; } ``` diff --git a/docs/DocMember.md b/docs/DocMember.md index 5f327a9..1577c77 100644 --- a/docs/DocMember.md +++ b/docs/DocMember.md @@ -1,4 +1,4 @@ -# [Summary.DocMember](../src/Core/DocMember.cs#L7) +# [Summary.DocMember](../src/Core/DocMember.cs#L8) ```cs public abstract record DocMember ``` @@ -6,21 +6,21 @@ public abstract record DocMember A member of the generated document (e.g. type, field, property, method, etc.). ## Properties -### [FullyQualifiedName](../src/Core/DocMember.cs#L12) +### [FullyQualifiedName](../src/Core/DocMember.cs#L13) ```cs public required string FullyQualifiedName { get; init; } ``` The fully qualified name of the member (e.g., `Summary.DocMember`). -### [Name](../src/Core/DocMember.cs#L17) +### [Name](../src/Core/DocMember.cs#L18) ```cs public required string Name { get; init; } ``` The name of the member (e.g. `public int Field` has name `Field`). -### [Declaration](../src/Core/DocMember.cs#L23) +### [Declaration](../src/Core/DocMember.cs#L24) ```cs public required string Declaration { get; init; } ``` @@ -28,28 +28,28 @@ public required string Declaration { get; init; } The code-snippet that contains the full declaration of the member (e.g. `public int Field` is a declaration of the field member `Field`). -### [Access](../src/Core/DocMember.cs#L28) +### [Access](../src/Core/DocMember.cs#L29) ```cs public required AccessModifier Access { get; init; } ``` The access modifier of the member. -### [Comment](../src/Core/DocMember.cs#L33) +### [Comment](../src/Core/DocMember.cs#L34) ```cs public required DocComment Comment { get; init; } ``` The documentation comment of the member (can be empty). -### [DeclaringType](../src/Core/DocMember.cs#L38) +### [DeclaringType](../src/Core/DocMember.cs#L39) ```cs public required DocType? DeclaringType { get; init; } ``` The type that this member is declared in (works for nested types as well). -### [Deprecated](../src/Core/DocMember.cs#L44) +### [Deprecated](../src/Core/DocMember.cs#L45) ```cs [MemberNotNullWhen(true, nameof(Deprecation))] public bool Deprecated { get; } @@ -57,14 +57,14 @@ public bool Deprecated { get; } Whether the member is deprecated (e.g. marked with `[Obsolete]`). -### [Deprecation](../src/Core/DocMember.cs#L49) +### [Deprecation](../src/Core/DocMember.cs#L50) ```cs public DocDeprecation? Deprecation { get; init; } ``` The member deprecation information. -### [Location](../src/Core/DocMember.cs#L54) +### [Location](../src/Core/DocMember.cs#L55) ```cs public DocLocation? Location { get; init; } ``` @@ -72,7 +72,7 @@ public DocLocation? Location { get; init; } The location of the member. ## Methods -### [MatchesCref(string)](../src/Core/DocMember.cs#L59) +### [MatchesCref(string)](../src/Core/DocMember.cs#L60) ```cs public bool MatchesCref(string cref) ``` diff --git a/docs/DocMethod.md b/docs/DocMethod.md index 336a59d..e5dec26 100644 --- a/docs/DocMethod.md +++ b/docs/DocMethod.md @@ -1,4 +1,4 @@ -# [Summary.DocMethod](../src/Core/DocMethod.cs#L7) +# [Summary.DocMethod](../src/Core/DocMethod.cs#L8) ```cs public record DocMethod : DocMember ``` @@ -6,35 +6,35 @@ public record DocMethod : DocMember A [`DocMember`](./DocMember.md) that represents a documented method in the parsed source code. ## Properties -### [TypeParams](../src/Core/DocMethod.cs#L12) +### [TypeParams](../src/Core/DocMethod.cs#L13) ```cs public required DocTypeParam[] TypeParams { get; init; } ``` The type parameters of the method. -### [Params](../src/Core/DocMethod.cs#L17) +### [Params](../src/Core/DocMethod.cs#L18) ```cs public required DocParam[] Params { get; init; } ``` The parameters of the method. -### [Delegate](../src/Core/DocMethod.cs#L22) +### [Delegate](../src/Core/DocMethod.cs#L23) ```cs public required bool Delegate { get; init; } ``` Whether this method represents a delegate. -### [SignatureWithoutParams](../src/Core/DocMethod.cs#L27) +### [SignatureWithoutParams](../src/Core/DocMethod.cs#L28) ```cs public string SignatureWithoutParams { get; } ``` The signature of the method without parameters in link format (e.g., `Sum{T}`). -### [Signature](../src/Core/DocMethod.cs#L32) +### [Signature](../src/Core/DocMethod.cs#L33) ```cs public string Signature { get; } ``` diff --git a/docs/DocParam.md b/docs/DocParam.md index 0c0cad4..ef21795 100644 --- a/docs/DocParam.md +++ b/docs/DocParam.md @@ -1,4 +1,4 @@ -# [Summary.DocParam](../src/Core/DocParam.cs#L7) +# [Summary.DocParam](../src/Core/DocParam.cs#L8) ```cs public record DocParam(DocType? Type, string Name) ``` @@ -6,14 +6,14 @@ public record DocParam(DocType? Type, string Name) A parameter of a [`DocMethod`](./DocMethod.md). ## Properties -### [Type](../src/Core/DocParam.cs#L7) +### [Type](../src/Core/DocParam.cs#L8) ```cs public DocType? Type { get; } ``` The type of the parameter. -### [Name](../src/Core/DocParam.cs#L7) +### [Name](../src/Core/DocParam.cs#L8) ```cs public string Name { get; } ``` @@ -21,7 +21,7 @@ public string Name { get; } The name of the parameter. ## Methods -### [Comment(DocMember)](../src/Core/DocParam.cs#L12) +### [Comment(DocMember)](../src/Core/DocParam.cs#L13) ```cs public DocCommentElement? Comment(DocMember parent) ``` diff --git a/docs/DocProperty.md b/docs/DocProperty.md index 6a6edc1..906a50d 100644 --- a/docs/DocProperty.md +++ b/docs/DocProperty.md @@ -1,4 +1,4 @@ -# [Summary.DocProperty](../src/Core/DocProperty.cs#L5) +# [Summary.DocProperty](../src/Core/DocProperty.cs#L6) ```cs public record DocProperty : DocMember ``` @@ -6,21 +6,21 @@ public record DocProperty : DocMember A [`DocMember`](./DocMember.md) that represents a documented property in the parsed source code. ## Properties -### [Type](../src/Core/DocProperty.cs#L10) +### [Type](../src/Core/DocProperty.cs#L11) ```cs public required DocType Type { get; init; } ``` The type of the property. -### [Generated](../src/Core/DocProperty.cs#L15) +### [Generated](../src/Core/DocProperty.cs#L16) ```cs public required bool Generated { get; init; } ``` Whether this property was generated by compiler (e.g., it's a property of a record). -### [Event](../src/Core/DocProperty.cs#L20) +### [Event](../src/Core/DocProperty.cs#L21) ```cs public required bool Event { get; init; } ``` diff --git a/docs/DocType.md b/docs/DocType.md index 7df99c6..6031e99 100644 --- a/docs/DocType.md +++ b/docs/DocType.md @@ -1,4 +1,4 @@ -# [Summary.DocType](../src/Core/DocType.cs#L9) +# [Summary.DocType](../src/Core/DocType.cs#L10) ```cs public record DocType(string Name, DocType[] TypeParams) ``` @@ -6,21 +6,21 @@ public record DocType(string Name, DocType[] TypeParams) A simple type (e.g. `int`, `string`, `List`, etc.). ## Properties -### [FullName](../src/Core/DocType.cs#L14) +### [FullName](../src/Core/DocType.cs#L15) ```cs public string FullName { get; } ``` The full name of the type including its type parameters. -### [Name](../src/Core/DocType.cs#L9) +### [Name](../src/Core/DocType.cs#L10) ```cs public string Name { get; } ``` The name of the type (without generic arguments). -### [TypeParams](../src/Core/DocType.cs#L9) +### [TypeParams](../src/Core/DocType.cs#L10) ```cs public DocType[] TypeParams { get; } ``` diff --git a/docs/DocTypeDeclaration.md b/docs/DocTypeDeclaration.md index 54d0476..a72e7a9 100644 --- a/docs/DocTypeDeclaration.md +++ b/docs/DocTypeDeclaration.md @@ -1,4 +1,4 @@ -# [Summary.DocTypeDeclaration](../src/Core/DocTypeDeclaration.cs#L8) +# [Summary.DocTypeDeclaration](../src/Core/DocTypeDeclaration.cs#L9) ```cs public record DocTypeDeclaration : DocMember ``` @@ -7,35 +7,35 @@ A [`DocMember`](./DocMember.md) that represents a documented type declaration (e in the parsed source code. ## Properties -### [Members](../src/Core/DocTypeDeclaration.cs#L13) +### [Members](../src/Core/DocTypeDeclaration.cs#L14) ```cs public required DocMember[] Members { get; init; } ``` The members of this type (e.g. fields, properties, methods). -### [TypeParams](../src/Core/DocTypeDeclaration.cs#L18) +### [TypeParams](../src/Core/DocTypeDeclaration.cs#L19) ```cs public required DocTypeParam[] TypeParams { get; init; } ``` The type parameters of this type (if it's generic). -### [Base](../src/Core/DocTypeDeclaration.cs#L23) +### [Base](../src/Core/DocTypeDeclaration.cs#L24) ```cs public required DocType[] Base { get; init; } ``` The list of base types for this one. -### [Record](../src/Core/DocTypeDeclaration.cs#L28) +### [Record](../src/Core/DocTypeDeclaration.cs#L29) ```cs public required bool Record { get; init; } ``` Whether this type declaration is a record declaration. -### [AllMembers](../src/Core/DocTypeDeclaration.cs#L33) +### [AllMembers](../src/Core/DocTypeDeclaration.cs#L34) ```cs public IEnumerable AllMembers { get; } ``` @@ -43,14 +43,14 @@ public IEnumerable AllMembers { get; } All nested members (including children of children) of this type declaration. ## Methods -### [MembersOfType(DocMember)](../src/Core/DocTypeDeclaration.cs#L49) +### [MembersOfType(DocMember)](../src/Core/DocTypeDeclaration.cs#L50) ```cs public IEnumerable MembersOfType(DocMember member) ``` A sequence of members of this type declaration that has the same type as the specified one. -### [BaseDeclarationsAndSelf(Doc)](../src/Core/DocTypeDeclaration.cs#L58) +### [BaseDeclarationsAndSelf(Doc)](../src/Core/DocTypeDeclaration.cs#L59) ```cs public IEnumerable BaseDeclarationsAndSelf(Doc doc) ``` @@ -59,7 +59,7 @@ This type declaration and the sequence of type declarations that are base types _This method is recursive and will return the sequence of all base types, even non-direct ones._ -### [BaseDeclarations(Doc)](../src/Core/DocTypeDeclaration.cs#L65) +### [BaseDeclarations(Doc)](../src/Core/DocTypeDeclaration.cs#L66) ```cs public IEnumerable BaseDeclarations(Doc doc) ``` diff --git a/docs/DocTypeParam.md b/docs/DocTypeParam.md index 43d6f4e..d36aaeb 100644 --- a/docs/DocTypeParam.md +++ b/docs/DocTypeParam.md @@ -1,4 +1,4 @@ -# [Summary.DocTypeParam](../src/Core/DocTypeParam.cs#L6) +# [Summary.DocTypeParam](../src/Core/DocTypeParam.cs#L7) ```cs public record DocTypeParam(string Name) ``` @@ -6,7 +6,7 @@ public record DocTypeParam(string Name) A type parameter of a [`DocMember`](./DocMember.md). ## Properties -### [Name](../src/Core/DocTypeParam.cs#L6) +### [Name](../src/Core/DocTypeParam.cs#L7) ```cs public string Name { get; } ``` @@ -14,7 +14,7 @@ public string Name { get; } The name of the parameter. ## Methods -### [Comment(DocMember)](../src/Core/DocTypeParam.cs#L11) +### [Comment(DocMember)](../src/Core/DocTypeParam.cs#L12) ```cs public DocCommentElement? Comment(DocMember parent) ``` diff --git a/docs/Extensions.md b/docs/Extensions.md index 124b31b..4ce2318 100644 --- a/docs/Extensions.md +++ b/docs/Extensions.md @@ -1,4 +1,4 @@ -# [Summary.Tests.Extensions](../src/Tests/Extensions.cs#L7) +# [Summary.Tests.Extensions](../src/Tests/Extensions.cs#L8) ```cs public static class Extensions ``` @@ -6,7 +6,7 @@ public static class Extensions Extension methods that simplify unit testing and should not be included in the package. ## Methods -### [RunSync(IPipe)](../src/Tests/Extensions.cs#L13) +### [RunSync(IPipe)](../src/Tests/Extensions.cs#L14) ```cs public static O RunSync(this IPipe self) ``` @@ -16,7 +16,7 @@ Runs the pipe synchronously. #### Parameters - `self`: The pipe to execute. -### [RunSync(IPipe, I)](../src/Tests/Extensions.cs#L17) +### [RunSync(IPipe, I)](../src/Tests/Extensions.cs#L18) ```cs public static O RunSync(this IPipe self, I input) ``` diff --git a/docs/FilterMemberPipe.md b/docs/FilterMemberPipe.md index 129b8d3..3d4f6da 100644 --- a/docs/FilterMemberPipe.md +++ b/docs/FilterMemberPipe.md @@ -1,4 +1,4 @@ -# [Summary.Pipes.Filters.FilterMemberPipe](../src/Core/Pipes/Filters/FilterMemberPipe.cs#L5) +# [Summary.Pipes.Filters.FilterMemberPipe](../src/Core/Pipes/Filters/FilterMemberPipe.cs#L6) ```cs public class FilterMemberPipe : IPipe ``` @@ -6,7 +6,7 @@ public class FilterMemberPipe : IPipe A simple pipe that filters all members inside the document using the specified predicate. ## Methods -### [Run(Doc)](../src/Core/Pipes/Filters/FilterMemberPipe.cs#L7) +### [Run(Doc)](../src/Core/Pipes/Filters/FilterMemberPipe.cs#L8) ```cs public Task Run(Doc input) ``` diff --git a/docs/FoldPipe{O}.md b/docs/FoldPipe{O}.md index 4a52bce..7e86c98 100644 --- a/docs/FoldPipe{O}.md +++ b/docs/FoldPipe{O}.md @@ -1,4 +1,4 @@ -# [Summary.Pipes.FoldPipe](../src/Core/Pipes/FoldPipe.cs#L5) +# [Summary.Pipes.FoldPipe](../src/Core/Pipes/FoldPipe.cs#L6) ```cs public class FoldPipe : IPipe ``` @@ -6,7 +6,7 @@ public class FoldPipe : IPipe A [`IPipe{I,O}`](./IPipe{I,O}.md) that aggregates the result of the specified pipe. ## Methods -### [Run(O[])](../src/Core/Pipes/FoldPipe.cs#L7) +### [Run(O[])](../src/Core/Pipes/FoldPipe.cs#L8) ```cs public Task Run(O[] input) ``` diff --git a/docs/FuncPipe{I,O}.md b/docs/FuncPipe{I,O}.md index 15fa317..f944792 100644 --- a/docs/FuncPipe{I,O}.md +++ b/docs/FuncPipe{I,O}.md @@ -1,4 +1,4 @@ -# [Summary.Pipes.FuncPipe](../src/Core/Pipes/FuncPipe.cs#L5) +# [Summary.Pipes.FuncPipe](../src/Core/Pipes/FuncPipe.cs#L6) ```cs public class FuncPipe : IPipe ``` @@ -6,7 +6,7 @@ public class FuncPipe : IPipe A [`IPipe{I,O}`](./IPipe{I,O}.md) that wraps [`Func{I,O}`](./Func{I,O}.md). ## Methods -### [Run(I)](../src/Core/Pipes/FuncPipe.cs#L15) +### [Run(I)](../src/Core/Pipes/FuncPipe.cs#L16) ```cs public Task Run(I input) ``` diff --git a/docs/GlobalDelegate.md b/docs/GlobalDelegate.md index 0d1c3f4..6db43ba 100644 --- a/docs/GlobalDelegate.md +++ b/docs/GlobalDelegate.md @@ -1,4 +1,4 @@ -# [GlobalDelegate(int, int)](../src/Core/Samples/Sample.cs#L5) +# [GlobalDelegate(int, int)](../src/Core/Samples/Sample.cs#L6) ```cs public void GlobalDelegate(int x, int y) ``` diff --git a/docs/IInheritDocBase.md b/docs/IInheritDocBase.md index d47d880..2d40c49 100644 --- a/docs/IInheritDocBase.md +++ b/docs/IInheritDocBase.md @@ -1,4 +1,4 @@ -# [Summary.Samples.IInheritDocBase](../src/Core/Samples/InheritDocSample.cs#L184) +# [Summary.Samples.IInheritDocBase](../src/Core/Samples/InheritDocSample.cs#L185) ```cs public interface IInheritDocBase ``` diff --git a/docs/IPipe{I,O}.md b/docs/IPipe{I,O}.md index ac54c97..9852cf0 100644 --- a/docs/IPipe{I,O}.md +++ b/docs/IPipe{I,O}.md @@ -1,4 +1,4 @@ -# [Summary.Pipes.IPipe](../src/Core/Pipes/IPipe.cs#L7) +# [Summary.Pipes.IPipe](../src/Core/Pipes/IPipe.cs#L8) ```cs public interface IPipe ``` @@ -10,7 +10,7 @@ An asynchronous pipe that can transform an input to the output. - `O`: The type of the output of the pipe. ## Methods -### [Run(I)](../src/Core/Pipes/IPipe.cs#L12) +### [Run(I)](../src/Core/Pipes/IPipe.cs#L13) ```cs Task Run(I input) ``` diff --git a/docs/InheritDocBase.md b/docs/InheritDocBase.md index 37cef3d..e38b5cd 100644 --- a/docs/InheritDocBase.md +++ b/docs/InheritDocBase.md @@ -1,4 +1,4 @@ -# [Summary.Samples.InheritDocBase](../src/Core/Samples/InheritDocSample.cs#L8) +# [Summary.Samples.InheritDocBase](../src/Core/Samples/InheritDocSample.cs#L9) ```cs public class InheritDocBase ``` @@ -8,7 +8,7 @@ Summary. _Remarks section._ ## Delegates -### [Delegate1(int, int)](../src/Core/Samples/InheritDocSample.cs#L16) +### [Delegate1(int, int)](../src/Core/Samples/InheritDocSample.cs#L17) ```cs public void Delegate1(int x, int y) ``` @@ -22,7 +22,7 @@ A sample delegate. #### Returns Nothing. -### [Delegate2(int, int)](../src/Core/Samples/InheritDocSample.cs#L19) +### [Delegate2(int, int)](../src/Core/Samples/InheritDocSample.cs#L20) ```cs public void Delegate2(int x, int y) ``` @@ -36,13 +36,13 @@ A sample delegate. #### Returns Nothing. -### [Delegate3(int, int)](../src/Core/Samples/InheritDocSample.cs#L22) +### [Delegate3(int, int)](../src/Core/Samples/InheritDocSample.cs#L23) ```cs public void Delegate3(int x, int y) ``` ## Events -### [Event1](../src/Core/Samples/InheritDocSample.cs#L55) +### [Event1](../src/Core/Samples/InheritDocSample.cs#L56) ```cs public virtual event Action Event1 ``` @@ -50,14 +50,14 @@ public virtual event Action Event1 An event. ## Fields -### [Field1](../src/Core/Samples/InheritDocSample.cs#L27) +### [Field1](../src/Core/Samples/InheritDocSample.cs#L28) ```cs public int Field1 ``` A field. -### [Field2](../src/Core/Samples/InheritDocSample.cs#L30) +### [Field2](../src/Core/Samples/InheritDocSample.cs#L31) ```cs public int Field2 ``` @@ -65,7 +65,7 @@ public int Field2 A field. ## Properties -### [Property1](../src/Core/Samples/InheritDocSample.cs#L38) +### [Property1](../src/Core/Samples/InheritDocSample.cs#L39) ```cs public virtual int Property1 { get; set; } ``` @@ -74,7 +74,7 @@ A property. _Property remarks._ -### [Property2](../src/Core/Samples/InheritDocSample.cs#L41) +### [Property2](../src/Core/Samples/InheritDocSample.cs#L42) ```cs public virtual int Property2 { get; set; } ``` @@ -83,7 +83,7 @@ A property. _Property remarks._ -### [Property3](../src/Core/Samples/InheritDocSample.cs#L44) +### [Property3](../src/Core/Samples/InheritDocSample.cs#L45) ```cs public int Property3 { get; set; } ``` @@ -93,7 +93,7 @@ A property. _Property remarks._ ## Indexers -### [this[int]](../src/Core/Samples/InheritDocSample.cs#L50) +### [this[int]](../src/Core/Samples/InheritDocSample.cs#L51) ```cs public virtual int this[int i] { get; } ``` @@ -104,7 +104,7 @@ An indexer. - `i`: A parameter to the indexer. ## Methods -### [Sum(int, int)](../src/Core/Samples/InheritDocSample.cs#L63) +### [Sum(int, int)](../src/Core/Samples/InheritDocSample.cs#L64) ```cs public virtual int Sum(int x, int y) ``` @@ -118,7 +118,7 @@ Calculates the sum. #### Returns Returns the sum of two values. -### [Sum(byte, byte)](../src/Core/Samples/InheritDocSample.cs#L72) +### [Sum(byte, byte)](../src/Core/Samples/InheritDocSample.cs#L73) ```cs public byte Sum(byte x, byte y) ``` @@ -135,7 +135,7 @@ Calculates the byte sum. #### Returns Returns the sum of two values. -### [Sum(short, short)](../src/Core/Samples/InheritDocSample.cs#L75) +### [Sum(short, short)](../src/Core/Samples/InheritDocSample.cs#L76) ```cs public short Sum(short x, short y) ``` @@ -149,7 +149,7 @@ Calculates the byte sum. #### Returns Returns the sum of two values. -### [Sum2(short, short)](../src/Core/Samples/InheritDocSample.cs#L78) +### [Sum2(short, short)](../src/Core/Samples/InheritDocSample.cs#L79) ```cs public short Sum2(short x, short y) ``` @@ -163,7 +163,7 @@ Calculates the byte sum. #### Returns Returns the sum of two values. -### [Sum3(short, short)](../src/Core/Samples/InheritDocSample.cs#L81) +### [Sum3(short, short)](../src/Core/Samples/InheritDocSample.cs#L82) ```cs public short Sum3(short x, short y) ``` @@ -177,7 +177,7 @@ Calculates the byte sum. #### Returns Returns the sum of two values. -### [Sum4(short, short)](../src/Core/Samples/InheritDocSample.cs#L84) +### [Sum4(short, short)](../src/Core/Samples/InheritDocSample.cs#L85) ```cs public short Sum4(short x, short y) ``` diff --git a/docs/InheritDocRecordBase.md b/docs/InheritDocRecordBase.md index 95bb01d..dfc728f 100644 --- a/docs/InheritDocRecordBase.md +++ b/docs/InheritDocRecordBase.md @@ -1,4 +1,4 @@ -# [Summary.Samples.InheritDocRecordBase](../src/Core/Samples/InheritDocSample.cs#L193) +# [Summary.Samples.InheritDocRecordBase](../src/Core/Samples/InheritDocSample.cs#L194) ```cs public record InheritDocRecordBase(int Property) ``` @@ -6,7 +6,7 @@ public record InheritDocRecordBase(int Property) Summary (record). ## Properties -### [Property](../src/Core/Samples/InheritDocSample.cs#L193) +### [Property](../src/Core/Samples/InheritDocSample.cs#L194) ```cs public int Property { get; } ``` diff --git a/docs/InheritDocRecordBase_Child.md b/docs/InheritDocRecordBase_Child.md index b3ea8fa..cf69b08 100644 --- a/docs/InheritDocRecordBase_Child.md +++ b/docs/InheritDocRecordBase_Child.md @@ -1,4 +1,4 @@ -# [Summary.Samples.InheritDocRecordBase_Child](../src/Core/Samples/InheritDocSample.cs#L197) +# [Summary.Samples.InheritDocRecordBase_Child](../src/Core/Samples/InheritDocSample.cs#L198) ```cs public record InheritDocRecordBase_Child(int Property, int OtherProperty) : InheritDocRecordBase(Property) ``` @@ -6,14 +6,14 @@ public record InheritDocRecordBase_Child(int Property, int OtherProperty) : Inhe Summary (record). ## Properties -### [Property](../src/Core/Samples/InheritDocSample.cs#L197) +### [Property](../src/Core/Samples/InheritDocSample.cs#L198) ```cs public int Property { get; } ``` A property. -### [OtherProperty](../src/Core/Samples/InheritDocSample.cs#L197) +### [OtherProperty](../src/Core/Samples/InheritDocSample.cs#L198) ```cs public int OtherProperty { get; } ``` diff --git a/docs/InheritDoc_Child.md b/docs/InheritDoc_Child.md index 53fd671..217fbc0 100644 --- a/docs/InheritDoc_Child.md +++ b/docs/InheritDoc_Child.md @@ -1,4 +1,4 @@ -# [Summary.Samples.InheritDoc_Child](../src/Core/Samples/InheritDocSample.cs#L88) +# [Summary.Samples.InheritDoc_Child](../src/Core/Samples/InheritDocSample.cs#L89) ```cs public class InheritDoc_Child : InheritDocBase ``` @@ -8,7 +8,7 @@ Summary. _Remarks section._ ## Events -### [Event1](../src/Core/Samples/InheritDocSample.cs#L97) +### [Event1](../src/Core/Samples/InheritDocSample.cs#L98) ```cs public override event Action Event1 ``` @@ -16,7 +16,7 @@ public override event Action Event1 An event. ## Properties -### [Property1](../src/Core/Samples/InheritDocSample.cs#L91) +### [Property1](../src/Core/Samples/InheritDocSample.cs#L92) ```cs public override int Property1 { get; set; } ``` @@ -26,7 +26,7 @@ A property. _Property remarks._ ## Indexers -### [this[int]](../src/Core/Samples/InheritDocSample.cs#L94) +### [this[int]](../src/Core/Samples/InheritDocSample.cs#L95) ```cs public override int this[int i] { get; } ``` @@ -37,7 +37,7 @@ An indexer. - `i`: A parameter to the indexer. ## Methods -### [Sum(int, int)](../src/Core/Samples/InheritDocSample.cs#L100) +### [Sum(int, int)](../src/Core/Samples/InheritDocSample.cs#L101) ```cs public override int Sum(int x, int y) ``` diff --git a/docs/InheritDoc_Child2.md b/docs/InheritDoc_Child2.md index 9e9f498..e0a40be 100644 --- a/docs/InheritDoc_Child2.md +++ b/docs/InheritDoc_Child2.md @@ -1,4 +1,4 @@ -# [Summary.Samples.InheritDoc_Child2](../src/Core/Samples/InheritDocSample.cs#L104) +# [Summary.Samples.InheritDoc_Child2](../src/Core/Samples/InheritDocSample.cs#L105) ```cs public class InheritDoc_Child2 : InheritDoc_Child ``` @@ -8,28 +8,28 @@ Summary. _Remarks section._ ## Events -### [Event1](../src/Core/Samples/InheritDocSample.cs#L122) +### [Event1](../src/Core/Samples/InheritDocSample.cs#L123) ```cs public new event Action Event1 ``` An event. -### [Event2](../src/Core/Samples/InheritDocSample.cs#L125) +### [Event2](../src/Core/Samples/InheritDocSample.cs#L126) ```cs public event Action Event2 ``` An event. -### [Event3](../src/Core/Samples/InheritDocSample.cs#L128) +### [Event3](../src/Core/Samples/InheritDocSample.cs#L129) ```cs public event Action? Event3 ``` An event. -### [Event4](../src/Core/Samples/InheritDocSample.cs#L128) +### [Event4](../src/Core/Samples/InheritDocSample.cs#L129) ```cs public event Action? Event4 ``` @@ -37,7 +37,7 @@ public event Action? Event4 An event. ## Properties -### [Property1](../src/Core/Samples/InheritDocSample.cs#L107) +### [Property1](../src/Core/Samples/InheritDocSample.cs#L108) ```cs public override int Property1 { get; set; } ``` @@ -46,7 +46,7 @@ A property. _Property remarks._ -### [Property2](../src/Core/Samples/InheritDocSample.cs#L110) +### [Property2](../src/Core/Samples/InheritDocSample.cs#L111) ```cs public override int Property2 { get; set; } ``` @@ -55,7 +55,7 @@ A property. _Property remarks._ -### [Property4](../src/Core/Samples/InheritDocSample.cs#L113) +### [Property4](../src/Core/Samples/InheritDocSample.cs#L114) ```cs public int Property4 { get; set; } ``` @@ -64,7 +64,7 @@ A property. _Property remarks._ -### [Property5](../src/Core/Samples/InheritDocSample.cs#L116) +### [Property5](../src/Core/Samples/InheritDocSample.cs#L117) ```cs public int Property5 { get; set; } ``` @@ -74,7 +74,7 @@ A property. _Property remarks._ ## Indexers -### [this[int]](../src/Core/Samples/InheritDocSample.cs#L119) +### [this[int]](../src/Core/Samples/InheritDocSample.cs#L120) ```cs public override int this[int i] { get; } ``` @@ -85,7 +85,7 @@ An indexer. - `i`: A parameter to the indexer. ## Methods -### [Sum(int, int)](../src/Core/Samples/InheritDocSample.cs#L134) +### [Sum(int, int)](../src/Core/Samples/InheritDocSample.cs#L135) ```cs public override int Sum(int x, int y) ``` diff --git a/docs/InheritDoc_Child_OverrideSummary.md b/docs/InheritDoc_Child_OverrideSummary.md index 3f95df4..013abc5 100644 --- a/docs/InheritDoc_Child_OverrideSummary.md +++ b/docs/InheritDoc_Child_OverrideSummary.md @@ -1,4 +1,4 @@ -# [Summary.Samples.InheritDoc_Child_OverrideSummary](../src/Core/Samples/InheritDocSample.cs#L170) +# [Summary.Samples.InheritDoc_Child_OverrideSummary](../src/Core/Samples/InheritDocSample.cs#L171) ```cs public class InheritDoc_Child_OverrideSummary : InheritDocBase ``` diff --git a/docs/InheritDoc_Child_OverrideSummary2.md b/docs/InheritDoc_Child_OverrideSummary2.md index e7e6fd6..0e7ef91 100644 --- a/docs/InheritDoc_Child_OverrideSummary2.md +++ b/docs/InheritDoc_Child_OverrideSummary2.md @@ -1,4 +1,4 @@ -# [Summary.Samples.InheritDoc_Child_OverrideSummary2](../src/Core/Samples/InheritDocSample.cs#L176) +# [Summary.Samples.InheritDoc_Child_OverrideSummary2](../src/Core/Samples/InheritDocSample.cs#L177) ```cs public class InheritDoc_Child_OverrideSummary2 : InheritDocBase ``` diff --git a/docs/InheritDoc_CrefBase.md b/docs/InheritDoc_CrefBase.md index 253f3af..8a9aa1a 100644 --- a/docs/InheritDoc_CrefBase.md +++ b/docs/InheritDoc_CrefBase.md @@ -1,4 +1,4 @@ -# [Summary.Samples.InheritDoc_CrefBase](../src/Core/Samples/InheritDocSample.cs#L143) +# [Summary.Samples.InheritDoc_CrefBase](../src/Core/Samples/InheritDocSample.cs#L144) ```cs public class InheritDoc_CrefBase ``` @@ -8,7 +8,7 @@ Summary. _Remarks._ ## Methods -### [Sum(int, int)](../src/Core/Samples/InheritDocSample.cs#L151) +### [Sum(int, int)](../src/Core/Samples/InheritDocSample.cs#L152) ```cs public int Sum(int x, int y) ``` @@ -22,7 +22,7 @@ Calculates the sum. #### Returns Returns the sum of two values. -### [Sum(long, long)](../src/Core/Samples/InheritDocSample.cs#L154) +### [Sum(long, long)](../src/Core/Samples/InheritDocSample.cs#L155) ```cs public long Sum(long x, long y) ``` @@ -36,7 +36,7 @@ Calculates the sum. #### Returns Returns the sum of two values. -### [Sum_OverrideSummary(long, long)](../src/Core/Samples/InheritDocSample.cs#L160) +### [Sum_OverrideSummary(long, long)](../src/Core/Samples/InheritDocSample.cs#L161) ```cs public long Sum_OverrideSummary(long x, long y) ``` diff --git a/docs/InheritDoc_CrefBase_Child.md b/docs/InheritDoc_CrefBase_Child.md index 8570745..2a4d629 100644 --- a/docs/InheritDoc_CrefBase_Child.md +++ b/docs/InheritDoc_CrefBase_Child.md @@ -1,4 +1,4 @@ -# [Summary.Samples.InheritDoc_CrefBase_Child](../src/Core/Samples/InheritDocSample.cs#L164) +# [Summary.Samples.InheritDoc_CrefBase_Child](../src/Core/Samples/InheritDocSample.cs#L165) ```cs public class InheritDoc_CrefBase_Child : InheritDoc_CrefBase ``` diff --git a/docs/InheritDoc_InterfaceChild.md b/docs/InheritDoc_InterfaceChild.md index 5919c40..316d2c4 100644 --- a/docs/InheritDoc_InterfaceChild.md +++ b/docs/InheritDoc_InterfaceChild.md @@ -1,4 +1,4 @@ -# [Summary.Samples.InheritDoc_InterfaceChild](../src/Core/Samples/InheritDocSample.cs#L187) +# [Summary.Samples.InheritDoc_InterfaceChild](../src/Core/Samples/InheritDocSample.cs#L188) ```cs public class InheritDoc_InterfaceChild : IInheritDocBase ``` diff --git a/docs/InlineInheritDocPipe.md b/docs/InlineInheritDocPipe.md index 79ef898..eec24b1 100644 --- a/docs/InlineInheritDocPipe.md +++ b/docs/InlineInheritDocPipe.md @@ -1,4 +1,4 @@ -# [Summary.Roslyn.CSharp.InlineInheritDocPipe](../src/Plugins/Roslyn/CSharp/InlineInheritDocPipe.cs#L16) +# [Summary.Roslyn.CSharp.InlineInheritDocPipe](../src/Plugins/Roslyn/CSharp/InlineInheritDocPipe.cs#L17) ```cs public class InlineInheritDocPipe : IPipe ``` @@ -12,7 +12,7 @@ _- if this member contains an `` element, it's removed from the mem _- then, the inherited documentation (either from the base type or from the specified cref) is added to the member comment._ ## Methods -### [Run(Doc)](../src/Plugins/Roslyn/CSharp/InlineInheritDocPipe.cs#L18) +### [Run(Doc)](../src/Plugins/Roslyn/CSharp/InlineInheritDocPipe.cs#L19) ```cs public Task Run(Doc doc) ``` diff --git a/docs/LoggedPipe{I,O}.md b/docs/LoggedPipe{I,O}.md index 2c7158d..7a367c5 100644 --- a/docs/LoggedPipe{I,O}.md +++ b/docs/LoggedPipe{I,O}.md @@ -1,4 +1,4 @@ -# [Summary.Pipes.Logging.LoggedPipe](../src/Core/Pipes/Logging/LoggedPipe.cs#L10) +# [Summary.Pipes.Logging.LoggedPipe](../src/Core/Pipes/Logging/LoggedPipe.cs#L11) ```cs public class LoggedPipe : IPipe ``` @@ -8,7 +8,7 @@ A [`IPipe{I,O}`](./IPipe{I,O}.md) whose output is logged using the provided logg _Logging is implemented by simply beginning a new scope with the given message._ ## Methods -### [Run(I)](../src/Core/Pipes/Logging/LoggedPipe.cs#L15) +### [Run(I)](../src/Core/Pipes/Logging/LoggedPipe.cs#L16) ```cs public Task Run(I input) ``` diff --git a/docs/MarkdownPipelineExtensions.md b/docs/MarkdownPipelineExtensions.md index d92feff..a1376a5 100644 --- a/docs/MarkdownPipelineExtensions.md +++ b/docs/MarkdownPipelineExtensions.md @@ -1,4 +1,4 @@ -# [Summary.Markdown.MarkdownPipelineExtensions](../src/Plugins/Markdown/MarkdownPipelineExtensions.cs#L10) +# [Summary.Markdown.MarkdownPipelineExtensions](../src/Plugins/Markdown/MarkdownPipelineExtensions.cs#L11) ```cs public static class MarkdownPipelineExtensions ``` @@ -6,7 +6,7 @@ public static class MarkdownPipelineExtensions A set of extension methods that extend different pipelines with Markdown rendering. ## Methods -### [UseMdRenderer(SummaryPipeline, string, bool)](../src/Plugins/Markdown/MarkdownPipelineExtensions.cs#L18) +### [UseMdRenderer(SummaryPipeline, string, bool)](../src/Plugins/Markdown/MarkdownPipelineExtensions.cs#L19) ```cs public static SummaryPipeline UseMdRenderer(this SummaryPipeline self, string output, bool cleanup = true) ``` diff --git a/docs/MarkdownTests.md b/docs/MarkdownTests.md index c470cc4..7f0b494 100644 --- a/docs/MarkdownTests.md +++ b/docs/MarkdownTests.md @@ -1,22 +1,22 @@ -# [Summary.Tests.Markdown.MarkdownTests](../src/Tests/Markdown/MarkdownTests.cs#L6) +# [Summary.Tests.Markdown.MarkdownTests](../src/Tests/Markdown/MarkdownTests.cs#L7) ```cs public class MarkdownTests ``` ## Methods -### [NewLinePreserved()](../src/Tests/Markdown/MarkdownTests.cs#L9) +### [NewLinePreserved()](../src/Tests/Markdown/MarkdownTests.cs#L10) ```cs [Fact] public void NewLinePreserved() ``` -### [LinkBeforeDot()](../src/Tests/Markdown/MarkdownTests.cs#L21) +### [LinkBeforeDot()](../src/Tests/Markdown/MarkdownTests.cs#L22) ```cs [Fact] public void LinkBeforeDot() ``` -### [LinkBeforeSpace()](../src/Tests/Markdown/MarkdownTests.cs#L31) +### [LinkBeforeSpace()](../src/Tests/Markdown/MarkdownTests.cs#L32) ```cs [Fact] public void LinkBeforeSpace() diff --git a/docs/Md.md b/docs/Md.md index c6d6058..792953f 100644 --- a/docs/Md.md +++ b/docs/Md.md @@ -1,4 +1,4 @@ -# [Summary.Markdown.Md](../src/Plugins/Markdown/Md.cs#L7) +# [Summary.Markdown.Md](../src/Plugins/Markdown/Md.cs#L8) ```cs public record Md(string Name, string Content) ``` @@ -6,14 +6,14 @@ public record Md(string Name, string Content) A Markdown document file. ## Properties -### [Name](../src/Plugins/Markdown/Md.cs#L7) +### [Name](../src/Plugins/Markdown/Md.cs#L8) ```cs public string Name { get; } ``` The name of the document file. -### [Content](../src/Plugins/Markdown/Md.cs#L7) +### [Content](../src/Plugins/Markdown/Md.cs#L8) ```cs public string Content { get; } ``` diff --git a/docs/ParseDocPipe.md b/docs/ParseDocPipe.md index 057c510..11bb7f0 100644 --- a/docs/ParseDocPipe.md +++ b/docs/ParseDocPipe.md @@ -1,4 +1,4 @@ -# [Summary.Roslyn.CSharp.ParseDocPipe](../src/Plugins/Roslyn/CSharp/ParseDocPipe.cs#L11) +# [Summary.Roslyn.CSharp.ParseDocPipe](../src/Plugins/Roslyn/CSharp/ParseDocPipe.cs#L12) ```cs public class ParseDocPipe : IPipe ``` @@ -6,7 +6,7 @@ public class ParseDocPipe : IPipe A [`IPipe{I,O}`](./IPipe{I,O}.md) that transforms the specified syntax tree into parsed document. ## Methods -### [Run(SyntaxTree)](../src/Plugins/Roslyn/CSharp/ParseDocPipe.cs#L13) +### [Run(SyntaxTree)](../src/Plugins/Roslyn/CSharp/ParseDocPipe.cs#L14) ```cs public async Task Run(SyntaxTree input) ``` diff --git a/docs/ParseSyntaxTreePipe.md b/docs/ParseSyntaxTreePipe.md index f218ba2..2cc7fa3 100644 --- a/docs/ParseSyntaxTreePipe.md +++ b/docs/ParseSyntaxTreePipe.md @@ -1,4 +1,4 @@ -# [Summary.Roslyn.CSharp.ParseSyntaxTreePipe](../src/Plugins/Roslyn/CSharp/ParseSyntaxTreePipe.cs#L10) +# [Summary.Roslyn.CSharp.ParseSyntaxTreePipe](../src/Plugins/Roslyn/CSharp/ParseSyntaxTreePipe.cs#L11) ```cs public class ParseSyntaxTreePipe : IPipe ``` @@ -6,7 +6,7 @@ public class ParseSyntaxTreePipe : IPipe A [`IPipe{I,O}`](./IPipe{I,O}.md) that parses the specified string into a [`SyntaxTree`](./SyntaxTree.md). ## Methods -### [Run(Source)](../src/Plugins/Roslyn/CSharp/ParseSyntaxTreePipe.cs#L12) +### [Run(Source)](../src/Plugins/Roslyn/CSharp/ParseSyntaxTreePipe.cs#L13) ```cs public Task Run(Source input) ``` diff --git a/docs/PipeExtensions.md b/docs/PipeExtensions.md index 9b705d3..8d252f0 100644 --- a/docs/PipeExtensions.md +++ b/docs/PipeExtensions.md @@ -1,4 +1,4 @@ -# [Summary.Pipes.PipeExtensions](../src/Core/Pipes/PipeExtensions.cs#L8) +# [Summary.Pipes.PipeExtensions](../src/Core/Pipes/PipeExtensions.cs#L9) ```cs public static class PipeExtensions ``` @@ -6,82 +6,82 @@ public static class PipeExtensions Extension methods for [`IPipe{I,O}`](./IPipe{I,O}.md). ## Methods -### [Fold(IPipe)](../src/Core/Pipes/PipeExtensions.cs#L13) +### [Fold(IPipe)](../src/Core/Pipes/PipeExtensions.cs#L14) ```cs public static IPipe Fold(this IPipe self) ``` Folds the result of the specified pipe into a single [`Unit`](./Unit.md) value. -### [Run(IPipe)](../src/Core/Pipes/PipeExtensions.cs#L19) +### [Run(IPipe)](../src/Core/Pipes/PipeExtensions.cs#L20) ```cs public static Task Run(this IPipe self) ``` Asynchronously runs the pipe. -### [Then(IPipe, IPipe)](../src/Core/Pipes/PipeExtensions.cs#L25) +### [Then(IPipe, IPipe)](../src/Core/Pipes/PipeExtensions.cs#L26) ```cs public static IPipe Then(this IPipe a, IPipe 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(IPipe, IPipe, bool)](../src/Core/Pipes/PipeExtensions.cs#L31) +### [Then(IPipe, IPipe, bool)](../src/Core/Pipes/PipeExtensions.cs#L32) ```cs public static IPipe Then(this IPipe a, IPipe 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(IPipe, Func)](../src/Core/Pipes/PipeExtensions.cs#L37) +### [Then(IPipe, Func)](../src/Core/Pipes/PipeExtensions.cs#L38) ```cs public static IPipe Then(this IPipe a, Func map) ``` Constructs a new pipe that will apply the specified `select` function to the output of the current pipe. -### [Then(IPipe, Func, bool)](../src/Core/Pipes/PipeExtensions.cs#L43) +### [Then(IPipe, Func, bool)](../src/Core/Pipes/PipeExtensions.cs#L44) ```cs public static IPipe Then(this IPipe a, Func map, bool when) ``` Constructs a new pipe that will apply the specified `select` function to the output of the current pipe. -### [ThenForEach(IPipe, IPipe)](../src/Core/Pipes/PipeExtensions.cs#L49) +### [ThenForEach(IPipe, IPipe)](../src/Core/Pipes/PipeExtensions.cs#L50) ```cs public static IPipe ThenForEach(this IPipe a, IPipe b) ``` Constructs a new pipe that will apply the specified map pipe to the each element of the output of the current pipe. -### [Tee(IPipe, Action)](../src/Core/Pipes/PipeExtensions.cs#L55) +### [Tee(IPipe, Action)](../src/Core/Pipes/PipeExtensions.cs#L56) ```cs public static IPipe Tee(this IPipe a, Action action) ``` Constructs a new pipe that will execute the specified action on the output. -### [Logged(IPipe, ILoggerFactory, string)](../src/Core/Pipes/PipeExtensions.cs#L61) +### [Logged(IPipe, ILoggerFactory, string)](../src/Core/Pipes/PipeExtensions.cs#L62) ```cs public static IPipe Logged(this IPipe self, ILoggerFactory factory, string message) ``` Logs the execution of the given pipe using the specified logger factory. -### [Logged(IPipe, ILoggerFactory, Func)](../src/Core/Pipes/PipeExtensions.cs#L64) +### [Logged(IPipe, ILoggerFactory, Func)](../src/Core/Pipes/PipeExtensions.cs#L65) ```cs public static IPipe Logged(this IPipe self, ILoggerFactory factory, Func message) ``` -### [Logged(IPipe, ILogger, string)](../src/Core/Pipes/PipeExtensions.cs#L70) +### [Logged(IPipe, ILogger, string)](../src/Core/Pipes/PipeExtensions.cs#L71) ```cs public static IPipe Logged(this IPipe self, ILogger logger, string message) ``` Logs the execution of the given pipe using the specified logger. -### [Logged(IPipe, ILogger, Func)](../src/Core/Pipes/PipeExtensions.cs#L73) +### [Logged(IPipe, ILogger, Func)](../src/Core/Pipes/PipeExtensions.cs#L74) ```cs public static IPipe Logged(this IPipe self, ILogger logger, Func message) ``` diff --git a/docs/PipesTests.md b/docs/PipesTests.md index 3e29533..aeb2f83 100644 --- a/docs/PipesTests.md +++ b/docs/PipesTests.md @@ -1,28 +1,28 @@ -# [Summary.Tests.Core.PipesTests](../src/Tests/Core/PipesTests.cs#L4) +# [Summary.Tests.Core.PipesTests](../src/Tests/Core/PipesTests.cs#L5) ```cs public class PipesTests ``` ## Methods -### [Func()](../src/Tests/Core/PipesTests.cs#L7) +### [Func()](../src/Tests/Core/PipesTests.cs#L8) ```cs [Fact] public void Func() ``` -### [Then()](../src/Tests/Core/PipesTests.cs#L18) +### [Then()](../src/Tests/Core/PipesTests.cs#L19) ```cs [Fact] public void Then() ``` -### [Tee()](../src/Tests/Core/PipesTests.cs#L34) +### [Tee()](../src/Tests/Core/PipesTests.cs#L35) ```cs [Fact] public void Tee() ``` -### [Select()](../src/Tests/Core/PipesTests.cs#L48) +### [Select()](../src/Tests/Core/PipesTests.cs#L49) ```cs [Fact] public void Select() diff --git a/docs/RenderMarkdownPipe.md b/docs/RenderMarkdownPipe.md index c023871..f36f283 100644 --- a/docs/RenderMarkdownPipe.md +++ b/docs/RenderMarkdownPipe.md @@ -1,4 +1,4 @@ -# [Summary.Markdown.RenderMarkdownPipe](../src/Plugins/Markdown/RenderMarkdownPipe.cs#L8) +# [Summary.Markdown.RenderMarkdownPipe](../src/Plugins/Markdown/RenderMarkdownPipe.cs#L9) ```cs public class RenderMarkdownPipe : IPipe ``` @@ -6,7 +6,7 @@ public class RenderMarkdownPipe : IPipe A [`IPipe{I,O}`](./IPipe{I,O}.md) that renders generated document into the sequence of Markdown files. ## Methods -### [Run(Doc)](../src/Plugins/Markdown/RenderMarkdownPipe.cs#L15) +### [Run(Doc)](../src/Plugins/Markdown/RenderMarkdownPipe.cs#L16) ```cs public Task Run(Doc doc) ``` diff --git a/docs/RoslynParserTests.md b/docs/RoslynParserTests.md index 5b9a20d..d07ef87 100644 --- a/docs/RoslynParserTests.md +++ b/docs/RoslynParserTests.md @@ -1,22 +1,22 @@ -# [Summary.Tests.Roslyn.RoslynParserTests](../src/Tests/Roslyn/RoslynParserTests.cs#L5) +# [Summary.Tests.Roslyn.RoslynParserTests](../src/Tests/Roslyn/RoslynParserTests.cs#L6) ```cs public class RoslynParserTests ``` ## Methods -### [Class()](../src/Tests/Roslyn/RoslynParserTests.cs#L8) +### [Class()](../src/Tests/Roslyn/RoslynParserTests.cs#L9) ```cs [Fact] public void Class() ``` -### [Record()](../src/Tests/Roslyn/RoslynParserTests.cs#L16) +### [Record()](../src/Tests/Roslyn/RoslynParserTests.cs#L17) ```cs [Fact] public void Record() ``` -### [RecordStruct()](../src/Tests/Roslyn/RoslynParserTests.cs#L24) +### [RecordStruct()](../src/Tests/Roslyn/RoslynParserTests.cs#L25) ```cs [Fact] public void RecordStruct() diff --git a/docs/RoslynPipelineExtensions.md b/docs/RoslynPipelineExtensions.md index 233ce42..692908e 100644 --- a/docs/RoslynPipelineExtensions.md +++ b/docs/RoslynPipelineExtensions.md @@ -1,4 +1,4 @@ -# [Summary.Roslyn.RoslynPipelineExtensions](../src/Plugins/Roslyn/RoslynPipelineExtensions.cs#L12) +# [Summary.Roslyn.RoslynPipelineExtensions](../src/Plugins/Roslyn/RoslynPipelineExtensions.cs#L13) ```cs public static class RoslynPipelineExtensions ``` @@ -6,7 +6,7 @@ public static class RoslynPipelineExtensions A set of extension methods that extend different pipelines with Roslyn parsing. ## Methods -### [UseRoslynParser(SummaryPipeline, string, string)](../src/Plugins/Roslyn/RoslynPipelineExtensions.cs#L15) +### [UseRoslynParser(SummaryPipeline, string, string)](../src/Plugins/Roslyn/RoslynPipelineExtensions.cs#L16) ```cs public static SummaryPipeline UseRoslynParser(this SummaryPipeline self, string source, string pattern = "*.cs") ``` @@ -19,7 +19,7 @@ __ _Under the hood, we call [`System.IO.Directory.EnumerateFiles(string,string,SearchOption)`](./System.IO.Directory.EnumerateFiles(string,string,SearchOption).md) method_ _to get the list of all files for each of the specified root paths, and then concatenate the results._ -### [UseRoslynParser(SummaryPipeline, string[], string)](../src/Plugins/Roslyn/RoslynPipelineExtensions.cs#L28) +### [UseRoslynParser(SummaryPipeline, string[], string)](../src/Plugins/Roslyn/RoslynPipelineExtensions.cs#L29) ```cs public static SummaryPipeline UseRoslynParser(this SummaryPipeline self, string[] sources, string pattern = "*.cs") ``` diff --git a/docs/Sample{T0,T1}.Child.md b/docs/Sample{T0,T1}.Child.md index e423d42..57bf81e 100644 --- a/docs/Sample{T0,T1}.Child.md +++ b/docs/Sample{T0,T1}.Child.md @@ -1,4 +1,4 @@ -# [~~Summary.Samples.Sample.Child~~](../src/Core/Samples/Sample.cs#L32) +# [~~Summary.Samples.Sample.Child~~](../src/Core/Samples/Sample.cs#L33) > [!WARNING] > The type is deprecated. @@ -10,7 +10,7 @@ public class Child A child of the [`Sample{T0,T1}`](./Sample{T0,T1}.md) class. ## Fields -### [Field](../src/Core/Samples/Sample.cs#L37) +### [Field](../src/Core/Samples/Sample.cs#L38) ```cs public int Field ``` diff --git a/docs/Sample{T0,T1}.md b/docs/Sample{T0,T1}.md index 066ec58..ed8fd19 100644 --- a/docs/Sample{T0,T1}.md +++ b/docs/Sample{T0,T1}.md @@ -1,4 +1,4 @@ -# [Summary.Samples.Sample](../src/Core/Samples/Sample.cs#L25) +# [Summary.Samples.Sample](../src/Core/Samples/Sample.cs#L26) ```cs public class Sample ``` @@ -22,7 +22,7 @@ _Btw, this type has a child: [`Sample{T0,T1}.Child`](./Sample{T0,T1}.Child.md)._ - `T1`: A second type parameter. ## Delegates -### [Delegate1(int, int)](../src/Core/Samples/Sample.cs#L43) +### [Delegate1(int, int)](../src/Core/Samples/Sample.cs#L44) ```cs public void Delegate1(int x, int y) ``` @@ -30,14 +30,14 @@ public void Delegate1(int x, int y) A sample delegate. ## Events -### [Event1](../src/Core/Samples/Sample.cs#L90) +### [Event1](../src/Core/Samples/Sample.cs#L91) ```cs public event Action Event1 ``` A sample field event. -### [Event2](../src/Core/Samples/Sample.cs#L95) +### [Event2](../src/Core/Samples/Sample.cs#L96) ```cs public Action Event2 { add; remove; } ``` @@ -45,14 +45,14 @@ public Action Event2 { add; remove; } A sample property event. ## Fields -### [Field](../src/Core/Samples/Sample.cs#L37) +### [Field](../src/Core/Samples/Sample.cs#L38) ```cs public int Field ``` A field of the child class. -### [~~Field1~~](../src/Core/Samples/Sample.cs#L49) +### [~~Field1~~](../src/Core/Samples/Sample.cs#L50) > [!WARNING] > The field is deprecated. @@ -63,14 +63,14 @@ public int Field1 A sample field. -### [Field2](../src/Core/Samples/Sample.cs#L54) +### [Field2](../src/Core/Samples/Sample.cs#L55) ```cs public int Field2 ``` A pair of fields. -### [Field3](../src/Core/Samples/Sample.cs#L54) +### [Field3](../src/Core/Samples/Sample.cs#L55) ```cs public int Field3 ``` @@ -78,28 +78,28 @@ public int Field3 A pair of fields. ## Properties -### [Property1](../src/Core/Samples/Sample.cs#L59) +### [Property1](../src/Core/Samples/Sample.cs#L60) ```cs public int Property1 { get; set; } ``` A sample property. -### [Property2](../src/Core/Samples/Sample.cs#L64) +### [Property2](../src/Core/Samples/Sample.cs#L65) ```cs public int Property2 { private get; set; } ``` A sample property with custom visibility. -### [Property3](../src/Core/Samples/Sample.cs#L69) +### [Property3](../src/Core/Samples/Sample.cs#L70) ```cs public int Property3 { get; protected set; } ``` A sample property with custom visibility (2). -### [Property4](../src/Core/Samples/Sample.cs#L74) +### [Property4](../src/Core/Samples/Sample.cs#L75) ```cs public int Property4 { get; set; } ``` @@ -107,7 +107,7 @@ public int Property4 { get; set; } A sample property with custom accessors. ## Indexers -### [this[int]](../src/Core/Samples/Sample.cs#L85) +### [this[int]](../src/Core/Samples/Sample.cs#L86) ```cs public int this[int i] { get; } ``` @@ -121,7 +121,7 @@ A sample indexer. What indexer returns. ## Methods -### [Method(int, string)](../src/Core/Samples/Sample.cs#L117) +### [Method(int, string)](../src/Core/Samples/Sample.cs#L118) ```cs public TimeSpan Method(int x, string y) ``` @@ -147,7 +147,7 @@ It contains three type parameters: #### Returns The `TimeSpan` instance. -### [Method(short, string)](../src/Core/Samples/Sample.cs#L124) +### [Method(short, string)](../src/Core/Samples/Sample.cs#L125) ```cs public TimeSpan Method(short x, string y) ``` diff --git a/docs/SavePipe{I}.md b/docs/SavePipe{I}.md index 7db6c52..238219f 100644 --- a/docs/SavePipe{I}.md +++ b/docs/SavePipe{I}.md @@ -1,4 +1,4 @@ -# [Summary.Pipes.IO.SavePipe](../src/Core/Pipes/IO/SavePipe.cs#L5) +# [Summary.Pipes.IO.SavePipe](../src/Core/Pipes/IO/SavePipe.cs#L6) ```cs public class SavePipe : IPipe ``` @@ -6,7 +6,7 @@ public class SavePipe : IPipe A [`IPipe{I,O}`](./IPipe{I,O}.md) that saves the input to the file. ## Methods -### [Run(I)](../src/Core/Pipes/IO/SavePipe.cs#L7) +### [Run(I)](../src/Core/Pipes/IO/SavePipe.cs#L8) ```cs public async Task Run(I input) ``` diff --git a/docs/ScanPipe.md b/docs/ScanPipe.md index ef7138b..4a65840 100644 --- a/docs/ScanPipe.md +++ b/docs/ScanPipe.md @@ -1,4 +1,4 @@ -# [Summary.Pipes.IO.ScanPipe](../src/Core/Pipes/IO/ScanPipe.cs#L5) +# [Summary.Pipes.IO.ScanPipe](../src/Core/Pipes/IO/ScanPipe.cs#L6) ```cs public class ScanPipe : IPipe ``` @@ -6,7 +6,7 @@ public class ScanPipe : IPipe A [`IPipe{I,O}`](./IPipe{I,O}.md) that searches specified directory (recursively) for files that match specified pattern. ## Methods -### [Run(Unit)](../src/Core/Pipes/IO/ScanPipe.cs#L7) +### [Run(Unit)](../src/Core/Pipes/IO/ScanPipe.cs#L8) ```cs public async Task Run(Unit _) ``` diff --git a/docs/Source.md b/docs/Source.md index 9e15791..1f523e1 100644 --- a/docs/Source.md +++ b/docs/Source.md @@ -1,4 +1,4 @@ -# [Summary.Pipes.IO.Source](../src/Core/Pipes/IO/Source.cs#L7) +# [Summary.Pipes.IO.Source](../src/Core/Pipes/IO/Source.cs#L8) ```cs public record Source(string Text, string? Path = null) ``` @@ -6,14 +6,14 @@ public record Source(string Text, string? Path = null) A text file with source code. ## Properties -### [Text](../src/Core/Pipes/IO/Source.cs#L7) +### [Text](../src/Core/Pipes/IO/Source.cs#L8) ```cs public string Text { get; } ``` The text file content. -### [Path](../src/Core/Pipes/IO/Source.cs#L7) +### [Path](../src/Core/Pipes/IO/Source.cs#L8) ```cs public string? Path { get; } ``` @@ -21,7 +21,7 @@ public string? Path { get; } The path to the file. ## Methods -### [Read(string, CancellationToken)](../src/Core/Pipes/IO/Source.cs#L12) +### [Read(string, CancellationToken)](../src/Core/Pipes/IO/Source.cs#L13) ```cs public static async Task Read(string path, CancellationToken token = default) ``` diff --git a/docs/SummaryPipeline.Options.md b/docs/SummaryPipeline.Options.md index 62fee6c..e44db9e 100644 --- a/docs/SummaryPipeline.Options.md +++ b/docs/SummaryPipeline.Options.md @@ -1,4 +1,4 @@ -# [Summary.Pipelines.SummaryPipeline.Options](../src/Core/Pipelines/SummaryPipeline.cs#L21) +# [Summary.Pipelines.SummaryPipeline.Options](../src/Core/Pipelines/SummaryPipeline.cs#L22) ```cs public class Options ``` @@ -6,7 +6,7 @@ public class Options A set of options that configure the behavior of the summary pipeline. ## Properties -### [LoggerFactory](../src/Core/Pipelines/SummaryPipeline.cs#L28) +### [LoggerFactory](../src/Core/Pipelines/SummaryPipeline.cs#L29) ```cs public ILoggerFactory LoggerFactory { get; } ``` @@ -14,7 +14,7 @@ public ILoggerFactory LoggerFactory { get; } The factory that provides logger implementations. ## Methods -### [UseLoggerFactory(ILoggerFactory)](../src/Core/Pipelines/SummaryPipeline.cs#L33) +### [UseLoggerFactory(ILoggerFactory)](../src/Core/Pipelines/SummaryPipeline.cs#L34) ```cs public Options UseLoggerFactory(ILoggerFactory loggers) ``` diff --git a/docs/SummaryPipeline.md b/docs/SummaryPipeline.md index 0c5a4c0..7bfd61f 100644 --- a/docs/SummaryPipeline.md +++ b/docs/SummaryPipeline.md @@ -1,4 +1,4 @@ -# [Summary.Pipelines.SummaryPipeline](../src/Core/Pipelines/SummaryPipeline.cs#L16) +# [Summary.Pipelines.SummaryPipeline](../src/Core/Pipelines/SummaryPipeline.cs#L17) ```cs public class SummaryPipeline ``` @@ -12,14 +12,14 @@ _renderer pipe should render the parsed [`Doc`](./Doc.md) into some format (e.g. _and save it somewhere (e.g., file system)._ ## Properties -### [LoggerFactory](../src/Core/Pipelines/SummaryPipeline.cs#L28) +### [LoggerFactory](../src/Core/Pipelines/SummaryPipeline.cs#L29) ```cs public ILoggerFactory LoggerFactory { get; } ``` The factory that provides logger implementations. -### [Filters](../src/Core/Pipelines/SummaryPipeline.cs#L62) +### [Filters](../src/Core/Pipelines/SummaryPipeline.cs#L63) ```cs public List> Filters { get; } ``` @@ -29,49 +29,49 @@ The list of all filters applied after the document is parsed. _Filters are applied in a separate run after the document is successfully parsed._ ## Methods -### [UseLoggerFactory(ILoggerFactory)](../src/Core/Pipelines/SummaryPipeline.cs#L33) +### [UseLoggerFactory(ILoggerFactory)](../src/Core/Pipelines/SummaryPipeline.cs#L34) ```cs public Options UseLoggerFactory(ILoggerFactory loggers) ``` Specifies the logger factory that will be used to create loggers for the pipeline. -### [Customize(Func)](../src/Core/Pipelines/SummaryPipeline.cs#L67) +### [Customize(Func)](../src/Core/Pipelines/SummaryPipeline.cs#L68) ```cs public SummaryPipeline Customize(Func options) ``` Customizes the default pipeline options using the specified delegate. -### [ParseWith(Func>)](../src/Core/Pipelines/SummaryPipeline.cs#L73) +### [ParseWith(Func>)](../src/Core/Pipelines/SummaryPipeline.cs#L74) ```cs public SummaryPipeline ParseWith(Func> parser) ``` Specifies the custom parser with logging support for this pipeline. -### [ParseWith(IPipe)](../src/Core/Pipelines/SummaryPipeline.cs#L82) +### [ParseWith(IPipe)](../src/Core/Pipelines/SummaryPipeline.cs#L83) ```cs public SummaryPipeline ParseWith(IPipe parser) ``` Specifies the custom parser for this pipeline. -### [RenderWith(Func>)](../src/Core/Pipelines/SummaryPipeline.cs#L91) +### [RenderWith(Func>)](../src/Core/Pipelines/SummaryPipeline.cs#L92) ```cs public SummaryPipeline RenderWith(Func> render) ``` Specifies the custom renderer for this pipeline. -### [RenderWith(IPipe)](../src/Core/Pipelines/SummaryPipeline.cs#L100) +### [RenderWith(IPipe)](../src/Core/Pipelines/SummaryPipeline.cs#L101) ```cs public SummaryPipeline RenderWith(IPipe render) ``` Specifies the custom renderer for this pipeline. -### [Run()](../src/Core/Pipelines/SummaryPipeline.cs#L109) +### [Run()](../src/Core/Pipelines/SummaryPipeline.cs#L110) ```cs public async Task Run() ``` diff --git a/docs/SummaryPipelineExtensions.md b/docs/SummaryPipelineExtensions.md index cf60e6c..c09ae03 100644 --- a/docs/SummaryPipelineExtensions.md +++ b/docs/SummaryPipelineExtensions.md @@ -1,4 +1,4 @@ -# [Summary.Pipelines.SummaryPipelineExtensions](../src/Core/Pipelines/SummaryPipelineExtensions.cs#L9) +# [Summary.Pipelines.SummaryPipelineExtensions](../src/Core/Pipelines/SummaryPipelineExtensions.cs#L10) ```cs public static class SummaryPipelineExtensions ``` @@ -6,7 +6,7 @@ public static class SummaryPipelineExtensions Convenient extensions for [`SummaryPipeline`](./SummaryPipeline.md). ## Methods -### [UseLoggerFactory(SummaryPipeline, ILoggerFactory)](../src/Core/Pipelines/SummaryPipelineExtensions.cs#L18) +### [UseLoggerFactory(SummaryPipeline, ILoggerFactory)](../src/Core/Pipelines/SummaryPipelineExtensions.cs#L19) ```cs public static SummaryPipeline UseLoggerFactory(this SummaryPipeline self, ILoggerFactory factory) ``` @@ -16,14 +16,14 @@ Specifies the logger factory to use for pipes inside the pipeline. _This method should be called _before_ anything else so that_ _given logger factory is passed into all subsequent calls._ -### [UseDefaultFilters(SummaryPipeline)](../src/Core/Pipelines/SummaryPipelineExtensions.cs#L24) +### [UseDefaultFilters(SummaryPipeline)](../src/Core/Pipelines/SummaryPipelineExtensions.cs#L25) ```cs 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)](../src/Core/Pipelines/SummaryPipelineExtensions.cs#L39) +### [IncludeAtLeast(SummaryPipeline, AccessModifier)](../src/Core/Pipelines/SummaryPipelineExtensions.cs#L40) ```cs public static SummaryPipeline IncludeAtLeast(this SummaryPipeline self, AccessModifier access) ``` @@ -39,7 +39,7 @@ var pipeline = ...; pipeline.IncludeAtLeast(AccessModifier.Internal); ``` -### [IncludeOnly(SummaryPipeline, AccessModifier)](../src/Core/Pipelines/SummaryPipelineExtensions.cs#L54) +### [IncludeOnly(SummaryPipeline, AccessModifier)](../src/Core/Pipelines/SummaryPipelineExtensions.cs#L55) ```cs public static SummaryPipeline IncludeOnly(this SummaryPipeline self, AccessModifier access) ``` @@ -55,7 +55,7 @@ var pipeline = ...; pipeline.IncludeOnly(AccessModifier.Internal); ``` -### [UseFilter(SummaryPipeline, IPipe)](../src/Core/Pipelines/SummaryPipelineExtensions.cs#L61) +### [UseFilter(SummaryPipeline, IPipe)](../src/Core/Pipelines/SummaryPipelineExtensions.cs#L62) ```cs public static SummaryPipeline UseFilter(this SummaryPipeline self, IPipe filter) ``` diff --git a/docs/TeePipe{I,O}.md b/docs/TeePipe{I,O}.md index 94312fd..4f27f32 100644 --- a/docs/TeePipe{I,O}.md +++ b/docs/TeePipe{I,O}.md @@ -1,4 +1,4 @@ -# [Summary.Pipes.TeePipe](../src/Core/Pipes/TeePipe.cs#L5) +# [Summary.Pipes.TeePipe](../src/Core/Pipes/TeePipe.cs#L6) ```cs public class TeePipe : IPipe ``` @@ -6,7 +6,7 @@ public class TeePipe : IPipe A [`IPipe{I,O}`](./IPipe{I,O}.md) that invokes an action on the output of the pipe each time it's executed. ## Methods -### [Run(I)](../src/Core/Pipes/TeePipe.cs#L7) +### [Run(I)](../src/Core/Pipes/TeePipe.cs#L8) ```cs public async Task Run(I input) ``` diff --git a/docs/ThenForEach{I,O1,O2}.md b/docs/ThenForEach{I,O1,O2}.md index 2bc98b2..b4c41b6 100644 --- a/docs/ThenForEach{I,O1,O2}.md +++ b/docs/ThenForEach{I,O1,O2}.md @@ -1,4 +1,4 @@ -# [Summary.Pipes.ThenForEach](../src/Core/Pipes/ThenForEach.cs#L5) +# [Summary.Pipes.ThenForEach](../src/Core/Pipes/ThenForEach.cs#L6) ```cs public class ThenForEach : IPipe ``` @@ -6,7 +6,7 @@ public class ThenForEach : IPipe A [`IPipe{I,O}`](./IPipe{I,O}.md) that aggregates the result of the specified pipe. ## Methods -### [Run(I)](../src/Core/Pipes/ThenForEach.cs#L7) +### [Run(I)](../src/Core/Pipes/ThenForEach.cs#L8) ```cs public async Task Run(I input) ``` diff --git a/docs/ThenPipe{I,O1,O2}.md b/docs/ThenPipe{I,O1,O2}.md index 5e29404..c2374b0 100644 --- a/docs/ThenPipe{I,O1,O2}.md +++ b/docs/ThenPipe{I,O1,O2}.md @@ -1,4 +1,4 @@ -# [Summary.Pipes.ThenPipe](../src/Core/Pipes/ThenPipe.cs#L5) +# [Summary.Pipes.ThenPipe](../src/Core/Pipes/ThenPipe.cs#L6) ```cs public class ThenPipe : IPipe ``` @@ -6,7 +6,7 @@ public class ThenPipe : IPipe A [`IPipe{I,O}`](./IPipe{I,O}.md) that composes two pipes together. ## Methods -### [Run(I)](../src/Core/Pipes/ThenPipe.cs#L7) +### [Run(I)](../src/Core/Pipes/ThenPipe.cs#L8) ```cs public async Task Run(I i) ``` diff --git a/docs/Unit.md b/docs/Unit.md index f0f3692..0b24210 100644 --- a/docs/Unit.md +++ b/docs/Unit.md @@ -1,4 +1,4 @@ -# [Summary.Pipes.Unit](../src/Core/Pipes/Unit.cs#L5) +# [Summary.Pipes.Unit](../src/Core/Pipes/Unit.cs#L6) ```cs public class Unit ``` @@ -6,7 +6,7 @@ public class Unit A void type that is similar to `void` keyword. ## Fields -### [Value](../src/Core/Pipes/Unit.cs#L10) +### [Value](../src/Core/Pipes/Unit.cs#L11) ```cs public static readonly Unit Value ``` diff --git a/src/Plugins/Markdown/MdRenderer.cs b/src/Plugins/Markdown/MdRenderer.cs index 3713a96..78e8fcd 100644 --- a/src/Plugins/Markdown/MdRenderer.cs +++ b/src/Plugins/Markdown/MdRenderer.cs @@ -128,7 +128,7 @@ string Link(string text) var from = new Uri(_output); var to = new Uri(member.Location.Path); - return $"[{text}]({from.MakeRelativeUri(to)}#L{member.Location.Start.Line})"; + return $"[{text}]({from.MakeRelativeUri(to)}#L{member.Location.Start.Line + 1})"; } return text;