From 4418337a50d659423daebaa03b88a484a8bd5b54 Mon Sep 17 00:00:00 2001 From: Kostia Ohulchanskyi Date: Sun, 10 Dec 2023 18:07:41 +0000 Subject: [PATCH 1/2] Fix warnings --- docs/CleanupDirPipe{I}.md | 4 ++- docs/DocCommentElement.md | 10 ++++--- docs/FilterMemberPipe.md | 4 ++- docs/FoldPipe{O}.md | 4 ++- docs/FuncPipe{I,O}.md | 4 ++- docs/IInheritDocBase.md | 2 +- 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/LoggedPipe{I,O}.md | 4 ++- docs/MarkdownTests.md | 8 ++--- docs/PipeExtensions.md | 6 ++-- docs/RoslynParserTests.md | 8 ++--- docs/SavePipe{I}.md | 4 ++- docs/ScanPipe.md | 4 ++- docs/TeePipe{I,O}.md | 4 ++- docs/ThenForEach{I,O1,O2}.md | 4 ++- docs/ThenPipe{I,O1,O2}.md | 4 ++- src/Core/AccessModifier.cs | 4 +-- src/Core/DocCommentElement.cs | 9 ++++-- src/Core/Pipes/Filters/FilterMemberPipe.cs | 1 + src/Core/Pipes/FoldPipe.cs | 1 + src/Core/Pipes/FuncPipe.cs | 5 ++++ src/Core/Pipes/IO/CleanupDirPipe.cs | 1 + src/Core/Pipes/IO/SavePipe.cs | 1 + src/Core/Pipes/IO/ScanPipe.cs | 1 + src/Core/Pipes/Logging/LoggedPipe.cs | 4 +++ src/Core/Pipes/PipeExtensions.cs | 2 ++ src/Core/Pipes/TeePipe.cs | 1 + src/Core/Pipes/ThenForEach.cs | 1 + src/Core/Pipes/ThenPipe.cs | 1 + src/Core/Samples/InheritDocSample.cs | 22 ++++++++++---- 39 files changed, 137 insertions(+), 83 deletions(-) diff --git a/docs/CleanupDirPipe{I}.md b/docs/CleanupDirPipe{I}.md index 94799ae..8d1283c 100644 --- a/docs/CleanupDirPipe{I}.md +++ b/docs/CleanupDirPipe{I}.md @@ -6,8 +6,10 @@ public class CleanupDirPipe : IPipe Cleans up a given directory by deleting and re-creating it. ## Methods -### [Run(I)](../src/Core/Pipes/IO/CleanupDirPipe.cs#L8) +### [Run(I)](../src/Core/Pipes/IO/CleanupDirPipe.cs#L9) ```cs public Task Run(I input) ``` +Asynchronously processes the specified input and returns the output. + diff --git a/docs/DocCommentElement.md b/docs/DocCommentElement.md index 8a1725f..0675ffb 100644 --- a/docs/DocCommentElement.md +++ b/docs/DocCommentElement.md @@ -1,4 +1,4 @@ -# [Summary.DocCommentElement](../src/Core/DocCommentElement.cs#L11) +# [Summary.DocCommentElement](../src/Core/DocCommentElement.cs#L12) ```cs public record DocCommentElement(string Name, DocCommentElementAttribute[] Attributes, DocCommentNode[] Nodes) : DocCommentNode ``` @@ -8,19 +8,21 @@ 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#L11) +### [Name](../src/Core/DocCommentElement.cs#L12) ```cs public string Name { get; } ``` The name of the element (e.g. `remarks`, `summary`, `example`). -### [Attributes](../src/Core/DocCommentElement.cs#L11) +### [Attributes](../src/Core/DocCommentElement.cs#L12) ```cs public DocCommentElementAttribute[] Attributes { get; } ``` -### [Nodes](../src/Core/DocCommentElement.cs#L11) +The sequence of element attributes (e.g. `name`, `cref`). + +### [Nodes](../src/Core/DocCommentElement.cs#L12) ```cs public DocCommentNode[] Nodes { get; } ``` diff --git a/docs/FilterMemberPipe.md b/docs/FilterMemberPipe.md index 3d4f6da..d849770 100644 --- a/docs/FilterMemberPipe.md +++ b/docs/FilterMemberPipe.md @@ -6,8 +6,10 @@ 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#L8) +### [Run(Doc)](../src/Core/Pipes/Filters/FilterMemberPipe.cs#L9) ```cs public Task Run(Doc input) ``` +Asynchronously processes the specified input and returns the output. + diff --git a/docs/FoldPipe{O}.md b/docs/FoldPipe{O}.md index 7e86c98..785d95d 100644 --- a/docs/FoldPipe{O}.md +++ b/docs/FoldPipe{O}.md @@ -6,8 +6,10 @@ 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#L8) +### [Run(O[])](../src/Core/Pipes/FoldPipe.cs#L9) ```cs public Task Run(O[] input) ``` +Asynchronously processes the specified input and returns the output. + diff --git a/docs/FuncPipe{I,O}.md b/docs/FuncPipe{I,O}.md index f944792..46e3953 100644 --- a/docs/FuncPipe{I,O}.md +++ b/docs/FuncPipe{I,O}.md @@ -6,8 +6,10 @@ 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#L16) +### [Run(I)](../src/Core/Pipes/FuncPipe.cs#L21) ```cs public Task Run(I input) ``` +Asynchronously processes the specified input and returns the output. + diff --git a/docs/IInheritDocBase.md b/docs/IInheritDocBase.md index 2d40c49..67a8a55 100644 --- a/docs/IInheritDocBase.md +++ b/docs/IInheritDocBase.md @@ -1,4 +1,4 @@ -# [Summary.Samples.IInheritDocBase](../src/Core/Samples/InheritDocSample.cs#L185) +# [Summary.Samples.IInheritDocBase](../src/Core/Samples/InheritDocSample.cs#L195) ```cs public interface IInheritDocBase ``` diff --git a/docs/InheritDocBase.md b/docs/InheritDocBase.md index e38b5cd..9fadac8 100644 --- a/docs/InheritDocBase.md +++ b/docs/InheritDocBase.md @@ -1,4 +1,4 @@ -# [Summary.Samples.InheritDocBase](../src/Core/Samples/InheritDocSample.cs#L9) +# [Summary.Samples.InheritDocBase](../src/Core/Samples/InheritDocSample.cs#L19) ```cs public class InheritDocBase ``` @@ -8,7 +8,7 @@ Summary. _Remarks section._ ## Delegates -### [Delegate1(int, int)](../src/Core/Samples/InheritDocSample.cs#L17) +### [Delegate1(int, int)](../src/Core/Samples/InheritDocSample.cs#L27) ```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#L20) +### [Delegate2(int, int)](../src/Core/Samples/InheritDocSample.cs#L30) ```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#L23) +### [Delegate3(int, int)](../src/Core/Samples/InheritDocSample.cs#L33) ```cs public void Delegate3(int x, int y) ``` ## Events -### [Event1](../src/Core/Samples/InheritDocSample.cs#L56) +### [Event1](../src/Core/Samples/InheritDocSample.cs#L66) ```cs public virtual event Action Event1 ``` @@ -50,14 +50,14 @@ public virtual event Action Event1 An event. ## Fields -### [Field1](../src/Core/Samples/InheritDocSample.cs#L28) +### [Field1](../src/Core/Samples/InheritDocSample.cs#L38) ```cs public int Field1 ``` A field. -### [Field2](../src/Core/Samples/InheritDocSample.cs#L31) +### [Field2](../src/Core/Samples/InheritDocSample.cs#L41) ```cs public int Field2 ``` @@ -65,7 +65,7 @@ public int Field2 A field. ## Properties -### [Property1](../src/Core/Samples/InheritDocSample.cs#L39) +### [Property1](../src/Core/Samples/InheritDocSample.cs#L49) ```cs public virtual int Property1 { get; set; } ``` @@ -74,7 +74,7 @@ A property. _Property remarks._ -### [Property2](../src/Core/Samples/InheritDocSample.cs#L42) +### [Property2](../src/Core/Samples/InheritDocSample.cs#L52) ```cs public virtual int Property2 { get; set; } ``` @@ -83,7 +83,7 @@ A property. _Property remarks._ -### [Property3](../src/Core/Samples/InheritDocSample.cs#L45) +### [Property3](../src/Core/Samples/InheritDocSample.cs#L55) ```cs public int Property3 { get; set; } ``` @@ -93,7 +93,7 @@ A property. _Property remarks._ ## Indexers -### [this[int]](../src/Core/Samples/InheritDocSample.cs#L51) +### [this[int]](../src/Core/Samples/InheritDocSample.cs#L61) ```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#L64) +### [Sum(int, int)](../src/Core/Samples/InheritDocSample.cs#L74) ```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#L73) +### [Sum(byte, byte)](../src/Core/Samples/InheritDocSample.cs#L83) ```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#L76) +### [Sum(short, short)](../src/Core/Samples/InheritDocSample.cs#L86) ```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#L79) +### [Sum2(short, short)](../src/Core/Samples/InheritDocSample.cs#L89) ```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#L82) +### [Sum3(short, short)](../src/Core/Samples/InheritDocSample.cs#L92) ```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#L85) +### [Sum4(short, short)](../src/Core/Samples/InheritDocSample.cs#L95) ```cs public short Sum4(short x, short y) ``` diff --git a/docs/InheritDocRecordBase.md b/docs/InheritDocRecordBase.md index dfc728f..1acec86 100644 --- a/docs/InheritDocRecordBase.md +++ b/docs/InheritDocRecordBase.md @@ -1,4 +1,4 @@ -# [Summary.Samples.InheritDocRecordBase](../src/Core/Samples/InheritDocSample.cs#L194) +# [Summary.Samples.InheritDocRecordBase](../src/Core/Samples/InheritDocSample.cs#L204) ```cs public record InheritDocRecordBase(int Property) ``` @@ -6,7 +6,7 @@ public record InheritDocRecordBase(int Property) Summary (record). ## Properties -### [Property](../src/Core/Samples/InheritDocSample.cs#L194) +### [Property](../src/Core/Samples/InheritDocSample.cs#L204) ```cs public int Property { get; } ``` diff --git a/docs/InheritDocRecordBase_Child.md b/docs/InheritDocRecordBase_Child.md index cf69b08..a1a2bce 100644 --- a/docs/InheritDocRecordBase_Child.md +++ b/docs/InheritDocRecordBase_Child.md @@ -1,4 +1,4 @@ -# [Summary.Samples.InheritDocRecordBase_Child](../src/Core/Samples/InheritDocSample.cs#L198) +# [Summary.Samples.InheritDocRecordBase_Child](../src/Core/Samples/InheritDocSample.cs#L208) ```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#L198) +### [Property](../src/Core/Samples/InheritDocSample.cs#L208) ```cs public int Property { get; } ``` A property. -### [OtherProperty](../src/Core/Samples/InheritDocSample.cs#L198) +### [OtherProperty](../src/Core/Samples/InheritDocSample.cs#L208) ```cs public int OtherProperty { get; } ``` diff --git a/docs/InheritDoc_Child.md b/docs/InheritDoc_Child.md index 217fbc0..aca7ca1 100644 --- a/docs/InheritDoc_Child.md +++ b/docs/InheritDoc_Child.md @@ -1,4 +1,4 @@ -# [Summary.Samples.InheritDoc_Child](../src/Core/Samples/InheritDocSample.cs#L89) +# [Summary.Samples.InheritDoc_Child](../src/Core/Samples/InheritDocSample.cs#L99) ```cs public class InheritDoc_Child : InheritDocBase ``` @@ -8,7 +8,7 @@ Summary. _Remarks section._ ## Events -### [Event1](../src/Core/Samples/InheritDocSample.cs#L98) +### [Event1](../src/Core/Samples/InheritDocSample.cs#L108) ```cs public override event Action Event1 ``` @@ -16,7 +16,7 @@ public override event Action Event1 An event. ## Properties -### [Property1](../src/Core/Samples/InheritDocSample.cs#L92) +### [Property1](../src/Core/Samples/InheritDocSample.cs#L102) ```cs public override int Property1 { get; set; } ``` @@ -26,7 +26,7 @@ A property. _Property remarks._ ## Indexers -### [this[int]](../src/Core/Samples/InheritDocSample.cs#L95) +### [this[int]](../src/Core/Samples/InheritDocSample.cs#L105) ```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#L101) +### [Sum(int, int)](../src/Core/Samples/InheritDocSample.cs#L111) ```cs public override int Sum(int x, int y) ``` diff --git a/docs/InheritDoc_Child2.md b/docs/InheritDoc_Child2.md index e0a40be..dcc2100 100644 --- a/docs/InheritDoc_Child2.md +++ b/docs/InheritDoc_Child2.md @@ -1,4 +1,4 @@ -# [Summary.Samples.InheritDoc_Child2](../src/Core/Samples/InheritDocSample.cs#L105) +# [Summary.Samples.InheritDoc_Child2](../src/Core/Samples/InheritDocSample.cs#L115) ```cs public class InheritDoc_Child2 : InheritDoc_Child ``` @@ -8,28 +8,28 @@ Summary. _Remarks section._ ## Events -### [Event1](../src/Core/Samples/InheritDocSample.cs#L123) +### [Event1](../src/Core/Samples/InheritDocSample.cs#L133) ```cs public new event Action Event1 ``` An event. -### [Event2](../src/Core/Samples/InheritDocSample.cs#L126) +### [Event2](../src/Core/Samples/InheritDocSample.cs#L136) ```cs public event Action Event2 ``` An event. -### [Event3](../src/Core/Samples/InheritDocSample.cs#L129) +### [Event3](../src/Core/Samples/InheritDocSample.cs#L139) ```cs public event Action? Event3 ``` An event. -### [Event4](../src/Core/Samples/InheritDocSample.cs#L129) +### [Event4](../src/Core/Samples/InheritDocSample.cs#L139) ```cs public event Action? Event4 ``` @@ -37,7 +37,7 @@ public event Action? Event4 An event. ## Properties -### [Property1](../src/Core/Samples/InheritDocSample.cs#L108) +### [Property1](../src/Core/Samples/InheritDocSample.cs#L118) ```cs public override int Property1 { get; set; } ``` @@ -46,7 +46,7 @@ A property. _Property remarks._ -### [Property2](../src/Core/Samples/InheritDocSample.cs#L111) +### [Property2](../src/Core/Samples/InheritDocSample.cs#L121) ```cs public override int Property2 { get; set; } ``` @@ -55,7 +55,7 @@ A property. _Property remarks._ -### [Property4](../src/Core/Samples/InheritDocSample.cs#L114) +### [Property4](../src/Core/Samples/InheritDocSample.cs#L124) ```cs public int Property4 { get; set; } ``` @@ -64,7 +64,7 @@ A property. _Property remarks._ -### [Property5](../src/Core/Samples/InheritDocSample.cs#L117) +### [Property5](../src/Core/Samples/InheritDocSample.cs#L127) ```cs public int Property5 { get; set; } ``` @@ -74,7 +74,7 @@ A property. _Property remarks._ ## Indexers -### [this[int]](../src/Core/Samples/InheritDocSample.cs#L120) +### [this[int]](../src/Core/Samples/InheritDocSample.cs#L130) ```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#L135) +### [Sum(int, int)](../src/Core/Samples/InheritDocSample.cs#L145) ```cs public override int Sum(int x, int y) ``` diff --git a/docs/InheritDoc_Child_OverrideSummary.md b/docs/InheritDoc_Child_OverrideSummary.md index 013abc5..eb38030 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#L171) +# [Summary.Samples.InheritDoc_Child_OverrideSummary](../src/Core/Samples/InheritDocSample.cs#L181) ```cs public class InheritDoc_Child_OverrideSummary : InheritDocBase ``` diff --git a/docs/InheritDoc_Child_OverrideSummary2.md b/docs/InheritDoc_Child_OverrideSummary2.md index 0e7ef91..031f95c 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#L177) +# [Summary.Samples.InheritDoc_Child_OverrideSummary2](../src/Core/Samples/InheritDocSample.cs#L187) ```cs public class InheritDoc_Child_OverrideSummary2 : InheritDocBase ``` diff --git a/docs/InheritDoc_CrefBase.md b/docs/InheritDoc_CrefBase.md index 8a9aa1a..c3c9ce6 100644 --- a/docs/InheritDoc_CrefBase.md +++ b/docs/InheritDoc_CrefBase.md @@ -1,4 +1,4 @@ -# [Summary.Samples.InheritDoc_CrefBase](../src/Core/Samples/InheritDocSample.cs#L144) +# [Summary.Samples.InheritDoc_CrefBase](../src/Core/Samples/InheritDocSample.cs#L154) ```cs public class InheritDoc_CrefBase ``` @@ -8,7 +8,7 @@ Summary. _Remarks._ ## Methods -### [Sum(int, int)](../src/Core/Samples/InheritDocSample.cs#L152) +### [Sum(int, int)](../src/Core/Samples/InheritDocSample.cs#L162) ```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#L155) +### [Sum(long, long)](../src/Core/Samples/InheritDocSample.cs#L165) ```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#L161) +### [Sum_OverrideSummary(long, long)](../src/Core/Samples/InheritDocSample.cs#L171) ```cs public long Sum_OverrideSummary(long x, long y) ``` diff --git a/docs/InheritDoc_CrefBase_Child.md b/docs/InheritDoc_CrefBase_Child.md index 2a4d629..cc0610e 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#L165) +# [Summary.Samples.InheritDoc_CrefBase_Child](../src/Core/Samples/InheritDocSample.cs#L175) ```cs public class InheritDoc_CrefBase_Child : InheritDoc_CrefBase ``` diff --git a/docs/InheritDoc_InterfaceChild.md b/docs/InheritDoc_InterfaceChild.md index 316d2c4..1e69b23 100644 --- a/docs/InheritDoc_InterfaceChild.md +++ b/docs/InheritDoc_InterfaceChild.md @@ -1,4 +1,4 @@ -# [Summary.Samples.InheritDoc_InterfaceChild](../src/Core/Samples/InheritDocSample.cs#L188) +# [Summary.Samples.InheritDoc_InterfaceChild](../src/Core/Samples/InheritDocSample.cs#L198) ```cs public class InheritDoc_InterfaceChild : IInheritDocBase ``` diff --git a/docs/LoggedPipe{I,O}.md b/docs/LoggedPipe{I,O}.md index 7a367c5..306e954 100644 --- a/docs/LoggedPipe{I,O}.md +++ b/docs/LoggedPipe{I,O}.md @@ -8,8 +8,10 @@ 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#L16) +### [Run(I)](../src/Core/Pipes/Logging/LoggedPipe.cs#L20) ```cs public Task Run(I input) ``` +Asynchronously processes the specified input and returns the output. + diff --git a/docs/MarkdownTests.md b/docs/MarkdownTests.md index 7f0b494..2e88234 100644 --- a/docs/MarkdownTests.md +++ b/docs/MarkdownTests.md @@ -1,22 +1,22 @@ -# [Summary.Tests.Markdown.MarkdownTests](../src/Tests/Markdown/MarkdownTests.cs#L7) +# [Summary.Tests.Markdown.MarkdownTests](../src/Tests/Markdown/MarkdownTests.cs#L8) ```cs public class MarkdownTests ``` ## Methods -### [NewLinePreserved()](../src/Tests/Markdown/MarkdownTests.cs#L10) +### [NewLinePreserved()](../src/Tests/Markdown/MarkdownTests.cs#L11) ```cs [Fact] public void NewLinePreserved() ``` -### [LinkBeforeDot()](../src/Tests/Markdown/MarkdownTests.cs#L22) +### [LinkBeforeDot()](../src/Tests/Markdown/MarkdownTests.cs#L23) ```cs [Fact] public void LinkBeforeDot() ``` -### [LinkBeforeSpace()](../src/Tests/Markdown/MarkdownTests.cs#L32) +### [LinkBeforeSpace()](../src/Tests/Markdown/MarkdownTests.cs#L33) ```cs [Fact] public void LinkBeforeSpace() diff --git a/docs/PipeExtensions.md b/docs/PipeExtensions.md index 8d252f0..f74f38c 100644 --- a/docs/PipeExtensions.md +++ b/docs/PipeExtensions.md @@ -69,19 +69,19 @@ public static IPipe Logged(this IPipe self, ILoggerFactory fac Logs the execution of the given pipe using the specified logger factory. -### [Logged(IPipe, ILoggerFactory, Func)](../src/Core/Pipes/PipeExtensions.cs#L65) +### [Logged(IPipe, ILoggerFactory, Func)](../src/Core/Pipes/PipeExtensions.cs#L66) ```cs public static IPipe Logged(this IPipe self, ILoggerFactory factory, Func message) ``` -### [Logged(IPipe, ILogger, string)](../src/Core/Pipes/PipeExtensions.cs#L71) +### [Logged(IPipe, ILogger, string)](../src/Core/Pipes/PipeExtensions.cs#L72) ```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#L74) +### [Logged(IPipe, ILogger, Func)](../src/Core/Pipes/PipeExtensions.cs#L76) ```cs public static IPipe Logged(this IPipe self, ILogger logger, Func message) ``` diff --git a/docs/RoslynParserTests.md b/docs/RoslynParserTests.md index d07ef87..556a264 100644 --- a/docs/RoslynParserTests.md +++ b/docs/RoslynParserTests.md @@ -1,22 +1,22 @@ -# [Summary.Tests.Roslyn.RoslynParserTests](../src/Tests/Roslyn/RoslynParserTests.cs#L6) +# [Summary.Tests.Roslyn.RoslynParserTests](../src/Tests/Roslyn/RoslynParserTests.cs#L7) ```cs public class RoslynParserTests ``` ## Methods -### [Class()](../src/Tests/Roslyn/RoslynParserTests.cs#L9) +### [Class()](../src/Tests/Roslyn/RoslynParserTests.cs#L10) ```cs [Fact] public void Class() ``` -### [Record()](../src/Tests/Roslyn/RoslynParserTests.cs#L17) +### [Record()](../src/Tests/Roslyn/RoslynParserTests.cs#L18) ```cs [Fact] public void Record() ``` -### [RecordStruct()](../src/Tests/Roslyn/RoslynParserTests.cs#L25) +### [RecordStruct()](../src/Tests/Roslyn/RoslynParserTests.cs#L26) ```cs [Fact] public void RecordStruct() diff --git a/docs/SavePipe{I}.md b/docs/SavePipe{I}.md index 238219f..8f132d9 100644 --- a/docs/SavePipe{I}.md +++ b/docs/SavePipe{I}.md @@ -6,8 +6,10 @@ 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#L8) +### [Run(I)](../src/Core/Pipes/IO/SavePipe.cs#L9) ```cs public async Task Run(I input) ``` +Asynchronously processes the specified input and returns the output. + diff --git a/docs/ScanPipe.md b/docs/ScanPipe.md index 4a65840..26322df 100644 --- a/docs/ScanPipe.md +++ b/docs/ScanPipe.md @@ -6,8 +6,10 @@ 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#L8) +### [Run(Unit)](../src/Core/Pipes/IO/ScanPipe.cs#L9) ```cs public async Task Run(Unit _) ``` +Asynchronously processes the specified input and returns the output. + diff --git a/docs/TeePipe{I,O}.md b/docs/TeePipe{I,O}.md index 4f27f32..ae7767b 100644 --- a/docs/TeePipe{I,O}.md +++ b/docs/TeePipe{I,O}.md @@ -6,8 +6,10 @@ 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#L8) +### [Run(I)](../src/Core/Pipes/TeePipe.cs#L9) ```cs public async Task Run(I input) ``` +Asynchronously processes the specified input and returns the output. + diff --git a/docs/ThenForEach{I,O1,O2}.md b/docs/ThenForEach{I,O1,O2}.md index b4c41b6..20da460 100644 --- a/docs/ThenForEach{I,O1,O2}.md +++ b/docs/ThenForEach{I,O1,O2}.md @@ -6,8 +6,10 @@ 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#L8) +### [Run(I)](../src/Core/Pipes/ThenForEach.cs#L9) ```cs public async Task Run(I input) ``` +Asynchronously processes the specified input and returns the output. + diff --git a/docs/ThenPipe{I,O1,O2}.md b/docs/ThenPipe{I,O1,O2}.md index c2374b0..7ad15c7 100644 --- a/docs/ThenPipe{I,O1,O2}.md +++ b/docs/ThenPipe{I,O1,O2}.md @@ -6,8 +6,10 @@ 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#L8) +### [Run(I)](../src/Core/Pipes/ThenPipe.cs#L9) ```cs public async Task Run(I i) ``` +Asynchronously processes the specified input and returns the output. + diff --git a/src/Core/AccessModifier.cs b/src/Core/AccessModifier.cs index 410b146..1891547 100644 --- a/src/Core/AccessModifier.cs +++ b/src/Core/AccessModifier.cs @@ -1,10 +1,10 @@ namespace Summary; /// -/// An access modifier of a (e.g. `private`, `public`, etc.). +/// An access modifier of a (e.g. private, public, etc.). /// /// -/// The modifiers are ordered starting from the smallest one (). +/// The modifiers are ordered starting from the smallest one (). /// public enum AccessModifier { diff --git a/src/Core/DocCommentElement.cs b/src/Core/DocCommentElement.cs index 797aca0..24f5995 100644 --- a/src/Core/DocCommentElement.cs +++ b/src/Core/DocCommentElement.cs @@ -3,7 +3,8 @@ /// /// A that represents a compound element (e.g. summary, remarks, and other XML elements). /// -/// The name of the element (e.g. `remarks`, `summary`, `example`). +/// The name of the element (e.g. remarks, summary, example). +/// The sequence of element attributes (e.g. name, cref). /// The sequence of nodes this element consists of. /// /// Each element can contain simple text as well as other elements. @@ -12,8 +13,10 @@ public record DocCommentElement(string Name, DocCommentElementAttribute[] Attrib { internal DocComment Comment() => new(Nodes); - internal DocComment Summary() => new(new[] - { new DocCommentElement("summary", Array.Empty(), Nodes) }); + internal DocComment Summary() => new(new DocCommentNode[] + { + new DocCommentElement("summary", Array.Empty(), Nodes), + }); internal DocCommentElementAttribute? Attribute(string name) => Attributes.FirstOrDefault(x => x.Name == name); diff --git a/src/Core/Pipes/Filters/FilterMemberPipe.cs b/src/Core/Pipes/Filters/FilterMemberPipe.cs index 3611571..00f81c2 100644 --- a/src/Core/Pipes/Filters/FilterMemberPipe.cs +++ b/src/Core/Pipes/Filters/FilterMemberPipe.cs @@ -5,6 +5,7 @@ namespace Summary.Pipes.Filters; /// public class FilterMemberPipe(Predicate p) : IPipe { + /// public Task Run(Doc input) => Task.FromResult(new Doc(Filtered(input.Members))); diff --git a/src/Core/Pipes/FoldPipe.cs b/src/Core/Pipes/FoldPipe.cs index ecfcc04..6dc6391 100644 --- a/src/Core/Pipes/FoldPipe.cs +++ b/src/Core/Pipes/FoldPipe.cs @@ -5,6 +5,7 @@ /// public class FoldPipe(Func fold, O @default) : IPipe { + /// public Task Run(O[] input) => Task.FromResult(input.Length is 0 ? @default : input.Aggregate(fold)); } \ No newline at end of file diff --git a/src/Core/Pipes/FuncPipe.cs b/src/Core/Pipes/FuncPipe.cs index 9cfc4a7..c7ad52f 100644 --- a/src/Core/Pipes/FuncPipe.cs +++ b/src/Core/Pipes/FuncPipe.cs @@ -7,12 +7,17 @@ public class FuncPipe : IPipe { private readonly Func> _func; + /// public FuncPipe(Func func) => _func = i => Task.FromResult(func(i)); + /// + /// Initializes a pipe. + /// public FuncPipe(Func> func) => _func = func; + /// public Task Run(I input) => _func(input); } \ No newline at end of file diff --git a/src/Core/Pipes/IO/CleanupDirPipe.cs b/src/Core/Pipes/IO/CleanupDirPipe.cs index 886ee62..ca36f99 100644 --- a/src/Core/Pipes/IO/CleanupDirPipe.cs +++ b/src/Core/Pipes/IO/CleanupDirPipe.cs @@ -5,6 +5,7 @@ namespace Summary.Pipes.IO; /// public class CleanupDirPipe(string root) : IPipe { + /// public Task Run(I input) { if (Directory.Exists(root)) diff --git a/src/Core/Pipes/IO/SavePipe.cs b/src/Core/Pipes/IO/SavePipe.cs index 9a7feba..449acc1 100644 --- a/src/Core/Pipes/IO/SavePipe.cs +++ b/src/Core/Pipes/IO/SavePipe.cs @@ -5,6 +5,7 @@ /// public class SavePipe(string root, Func file) : IPipe { + /// public async Task Run(I input) { var (path, content) = file(input); diff --git a/src/Core/Pipes/IO/ScanPipe.cs b/src/Core/Pipes/IO/ScanPipe.cs index cf72ad1..4d366c0 100644 --- a/src/Core/Pipes/IO/ScanPipe.cs +++ b/src/Core/Pipes/IO/ScanPipe.cs @@ -5,6 +5,7 @@ /// public class ScanPipe(string[] sources, string pattern) : IPipe { + /// public async Task Run(Unit _) { // TODO: Consider refactoring this into more proper solution (@j.light). diff --git a/src/Core/Pipes/Logging/LoggedPipe.cs b/src/Core/Pipes/Logging/LoggedPipe.cs index c9a3a1e..61c36f7 100644 --- a/src/Core/Pipes/Logging/LoggedPipe.cs +++ b/src/Core/Pipes/Logging/LoggedPipe.cs @@ -10,9 +10,13 @@ namespace Summary.Pipes.Logging; /// public class LoggedPipe(IPipe inner, ILogger logger, Func message) : IPipe { + /// + /// Initializes a pipe. + /// public LoggedPipe(IPipe inner, ILogger logger, string message) : this(inner, logger, _ => message) { } + /// public Task Run(I input) { using var _ = logger.BeginScope(message(input)); diff --git a/src/Core/Pipes/PipeExtensions.cs b/src/Core/Pipes/PipeExtensions.cs index e955d9c..bc232d0 100644 --- a/src/Core/Pipes/PipeExtensions.cs +++ b/src/Core/Pipes/PipeExtensions.cs @@ -62,6 +62,7 @@ public static IPipe Tee(this IPipe a, Action action) => public static IPipe Logged(this IPipe self, ILoggerFactory factory, string message) => self.Logged(factory.CreateLogger(self.GetType().Name), message); + /// public static IPipe Logged(this IPipe self, ILoggerFactory factory, Func message) => self.Logged(factory.CreateLogger(self.GetType().Name), message); @@ -71,6 +72,7 @@ public static IPipe Logged(this IPipe self, ILoggerFactory fac public static IPipe Logged(this IPipe self, ILogger logger, string message) => new LoggedPipe(self, logger, message); + /// public static IPipe Logged(this IPipe self, ILogger logger, Func message) => new LoggedPipe(self, logger, message); } \ No newline at end of file diff --git a/src/Core/Pipes/TeePipe.cs b/src/Core/Pipes/TeePipe.cs index 301ce17..8f79158 100644 --- a/src/Core/Pipes/TeePipe.cs +++ b/src/Core/Pipes/TeePipe.cs @@ -5,6 +5,7 @@ /// public class TeePipe(IPipe inner, Action tee) : IPipe { + /// public async Task Run(I input) { var output = await inner.Run(input).ConfigureAwait(false); diff --git a/src/Core/Pipes/ThenForEach.cs b/src/Core/Pipes/ThenForEach.cs index b1c3ff0..0204c7a 100644 --- a/src/Core/Pipes/ThenForEach.cs +++ b/src/Core/Pipes/ThenForEach.cs @@ -5,6 +5,7 @@ /// public class ThenForEach(IPipe inner, IPipe map) : IPipe { + /// public async Task Run(I input) { var os = await inner.Run(input).ConfigureAwait(false); diff --git a/src/Core/Pipes/ThenPipe.cs b/src/Core/Pipes/ThenPipe.cs index 5690a63..04d3a31 100644 --- a/src/Core/Pipes/ThenPipe.cs +++ b/src/Core/Pipes/ThenPipe.cs @@ -5,6 +5,7 @@ /// public class ThenPipe(IPipe a, IPipe b) : IPipe { + /// public async Task Run(I i) { var x = await a.Run(i).ConfigureAwait(false); diff --git a/src/Core/Samples/InheritDocSample.cs b/src/Core/Samples/InheritDocSample.cs index fc15331..e0f51ac 100644 --- a/src/Core/Samples/InheritDocSample.cs +++ b/src/Core/Samples/InheritDocSample.cs @@ -1,4 +1,14 @@ -namespace Summary.Samples; +// ReSharper disable UnusedType.Global +// ReSharper disable UnusedMember.Global +// ReSharper disable EventNeverInvoked.Global +// ReSharper disable EventNeverSubscribedTo.Global +// ReSharper disable NotAccessedPositionalProperty.Global +#pragma warning disable CS0067 +#pragma warning disable CS1573 +#pragma warning disable CA1070 +#pragma warning disable CA1822 + +namespace Summary.Samples; /// /// Summary. @@ -162,19 +172,19 @@ public class InheritDoc_CrefBase } /// -public class InheritDoc_CrefBase_Child : InheritDoc_CrefBase { } +public class InheritDoc_CrefBase_Child : InheritDoc_CrefBase; /// /// Summary (child). /// /// -public class InheritDoc_Child_OverrideSummary : InheritDocBase { } +public class InheritDoc_Child_OverrideSummary : InheritDocBase; /// /// /// Summary (child). /// -public class InheritDoc_Child_OverrideSummary2 : InheritDocBase { } +public class InheritDoc_Child_OverrideSummary2 : InheritDocBase; /// /// Summary (interface). @@ -182,10 +192,10 @@ public class InheritDoc_Child_OverrideSummary2 : InheritDocBase { } /// /// Remarks section (interface). /// -public interface IInheritDocBase { } +public interface IInheritDocBase; /// -public class InheritDoc_InterfaceChild : IInheritDocBase { } +public class InheritDoc_InterfaceChild : IInheritDocBase; /// /// Summary (record). From bcff8c00f2e79844247d51917626fe510b6be7b3 Mon Sep 17 00:00:00 2001 From: Kostia Ohulchanskyi Date: Sun, 10 Dec 2023 18:14:30 +0000 Subject: [PATCH 2/2] Replace ` with --- docs/DocComment.md | 4 ++-- docs/DocCommentParamRef.md | 9 +++++---- docs/DocTypeDeclaration.md | 4 ++-- src/Core/AccessModifier.cs | 8 ++++---- src/Core/DocComment.cs | 14 +++++++------- src/Core/DocCommentElementAttribute.cs | 6 +++--- src/Core/DocCommentInheritDoc.cs | 2 +- src/Core/DocCommentLink.cs | 2 +- src/Core/DocCommentParamRef.cs | 5 +++-- src/Core/DocMember.cs | 8 ++++---- src/Core/DocMethod.cs | 4 ++-- src/Core/DocParam.cs | 2 +- src/Core/DocType.cs | 2 +- src/Core/DocTypeDeclaration.cs | 4 ++-- src/Core/DocTypeParam.cs | 2 +- src/Core/Extensions/EnumerableExtensions.cs | 4 ++-- src/Core/Extensions/StringExtensions.cs | 2 +- src/Core/Pipes/PipeExtensions.cs | 4 ++-- src/Core/Pipes/Unit.cs | 2 +- src/Core/Samples/Sample.cs | 10 +++++----- 20 files changed, 50 insertions(+), 48 deletions(-) diff --git a/docs/DocComment.md b/docs/DocComment.md index 74d23b4..c1bff46 100644 --- a/docs/DocComment.md +++ b/docs/DocComment.md @@ -27,7 +27,7 @@ The sequence of nodes this comment consists of (e.g. `summary`, `remarks`, etc.) public DocCommentElement? Param(string name) ``` -A nested documentation element that has the specified name. +A nested `` documentation element that has the specified name. #### Parameters - `name`: The name of the parameter to search inside the comment. @@ -37,7 +37,7 @@ A nested documentation element that has the specified name. public DocCommentElement? TypeParam(string name) ``` -A nested documentation element that has the specified name. +A nested `` documentation element that has the specified name. #### Parameters - `name`: The name of the parameter to search inside the comment. diff --git a/docs/DocCommentParamRef.md b/docs/DocCommentParamRef.md index afcc335..d7c9b47 100644 --- a/docs/DocCommentParamRef.md +++ b/docs/DocCommentParamRef.md @@ -1,15 +1,16 @@ -# [Summary.DocCommentParamRef](../src/Core/DocCommentParamRef.cs#L7) +# [Summary.DocCommentParamRef](../src/Core/DocCommentParamRef.cs#L8) ```cs public record DocCommentParamRef(string Value) : DocCommentNode ``` -A [`DocCommentNode`](./DocCommentNode.md) that represents the reference to a parameter (``, ``). +A [`DocCommentNode`](./DocCommentNode.md) that represents the reference to a parameter +(``, ``). ## Properties -### [Value](../src/Core/DocCommentParamRef.cs#L7) +### [Value](../src/Core/DocCommentParamRef.cs#L8) ```cs public string Value { get; } ``` -The name of the parameter . +The name of the parameter. diff --git a/docs/DocTypeDeclaration.md b/docs/DocTypeDeclaration.md index a72e7a9..c1fdcbe 100644 --- a/docs/DocTypeDeclaration.md +++ b/docs/DocTypeDeclaration.md @@ -3,8 +3,8 @@ public record DocTypeDeclaration : DocMember ``` -A [`DocMember`](./DocMember.md) that represents a documented type declaration (e.g. `struct`, `class`, etc.) -in the parsed source code. +A [`DocMember`](./DocMember.md) that represents a documented type declaration +(e.g. `struct`, `class`, etc.) in the parsed source code. ## Properties ### [Members](../src/Core/DocTypeDeclaration.cs#L14) diff --git a/src/Core/AccessModifier.cs b/src/Core/AccessModifier.cs index 1891547..00f99c0 100644 --- a/src/Core/AccessModifier.cs +++ b/src/Core/AccessModifier.cs @@ -9,22 +9,22 @@ public enum AccessModifier { /// - /// The `private` keyword access modifier. + /// The private keyword access modifier. /// Private, /// - /// The `protected` keyword access modifier. + /// The protected keyword access modifier. /// Protected, /// - /// The `internal` keyword access modifier. + /// The internal keyword access modifier. /// Internal, /// - /// The `public` keyword access modifier. + /// The public keyword access modifier. /// Public, } \ No newline at end of file diff --git a/src/Core/DocComment.cs b/src/Core/DocComment.cs index 9dfafad..f144d3f 100644 --- a/src/Core/DocComment.cs +++ b/src/Core/DocComment.cs @@ -3,7 +3,7 @@ /// /// A documentation comment parsed from the source code. /// -/// The sequence of nodes this comment consists of (e.g. `summary`, `remarks`, etc.). +/// The sequence of nodes this comment consists of (e.g. summary, remarks, etc.). public record DocComment(DocCommentNode[] Nodes) { /// @@ -12,36 +12,36 @@ public record DocComment(DocCommentNode[] Nodes) public static readonly DocComment Empty = new(Array.Empty()); /// - /// A nested <param> documentation element that has the specified name. + /// A nested <param> documentation element that has the specified name. /// /// The name of the parameter to search inside the comment. public DocCommentElement? Param(string name) => Element("param", name); /// - /// A nested <typeparam> documentation element that has the specified name. + /// A nested <typeparam> documentation element that has the specified name. /// /// The name of the parameter to search inside the comment. public DocCommentElement? TypeParam(string name) => Element("typeparam", name); /// - /// A nested documentation element that has the specified name (e.g. `summary`, `remarks`, etc.). + /// A nested documentation element that has the specified name (e.g. summary, remarks, etc.). /// /// The name of the element tag to search inside the comment. - /// The value of the `name` attribute of the tag. + /// The value of the name attribute of the tag. public DocCommentElement? Element(string tag, string name) => Element(x => x.Name == tag && x.Attribute("name")?.Value == name); /// - /// A nested documentation element that has the specified name (e.g. `summary`, `remarks`, etc.). + /// A nested documentation element that has the specified name (e.g. summary, remarks, etc.). /// /// The name of the element tag to search inside the comment. public DocCommentElement? Element(string tag) => Element(x => x.Name == tag); /// - /// A nested documentation element that matches the specified predicate `p`. + /// A nested documentation element that matches the specified predicate p. /// /// The predicate to apply on each nested documentation element. public DocCommentElement? Element(Func p) => diff --git a/src/Core/DocCommentElementAttribute.cs b/src/Core/DocCommentElementAttribute.cs index 2b9b472..3658e75 100644 --- a/src/Core/DocCommentElementAttribute.cs +++ b/src/Core/DocCommentElementAttribute.cs @@ -1,8 +1,8 @@ namespace Summary; /// -/// An XML-documentation attribute (e.g. `name` in `param`, etc.). +/// An XML-documentation attribute (e.g. name in param, etc.). /// -/// The name of the attribute (e.g. `name`, `cref`, etc.) -/// The value of the attribute (e.g. the actual name in `name` attribute). +/// The name of the attribute (e.g. name, cref, etc.) +/// The value of the attribute (e.g. the actual name in name attribute). public record DocCommentElementAttribute(string Name, string Value); \ No newline at end of file diff --git a/src/Core/DocCommentInheritDoc.cs b/src/Core/DocCommentInheritDoc.cs index a7986a3..4f52738 100644 --- a/src/Core/DocCommentInheritDoc.cs +++ b/src/Core/DocCommentInheritDoc.cs @@ -2,7 +2,7 @@ /// /// A that inherits documentation from another member -/// (`<inheritdoc>`). +/// (<inheritdoc>). /// /// An optional link to the member the documentation should be inherited from. public record DocCommentInheritDoc(string? Cref) : DocCommentNode; \ No newline at end of file diff --git a/src/Core/DocCommentLink.cs b/src/Core/DocCommentLink.cs index d34ffae..62e768d 100644 --- a/src/Core/DocCommentLink.cs +++ b/src/Core/DocCommentLink.cs @@ -1,7 +1,7 @@ namespace Summary; /// -/// A that represents the link to other member (e.g. `<see cref="SomeMember"/>`). +/// A that represents the link to other member (e.g. <see cref="SomeMember"/>). /// /// The name of the member the link links to. /// TODO: Should the link contain a `DocMember` instead of a string? diff --git a/src/Core/DocCommentParamRef.cs b/src/Core/DocCommentParamRef.cs index 1a61099..813a781 100644 --- a/src/Core/DocCommentParamRef.cs +++ b/src/Core/DocCommentParamRef.cs @@ -1,7 +1,8 @@ namespace Summary; /// -/// A that represents the reference to a parameter (`<paramref>`, `<typeparamref>`). +/// A that represents the reference to a parameter +/// (<paramref>, <typeparamref>). /// -/// The name of the parameter . +/// The name of the parameter. public record DocCommentParamRef(string Value) : DocCommentNode; \ No newline at end of file diff --git a/src/Core/DocMember.cs b/src/Core/DocMember.cs index ae25814..e9731b1 100644 --- a/src/Core/DocMember.cs +++ b/src/Core/DocMember.cs @@ -8,18 +8,18 @@ namespace Summary; public abstract record DocMember { /// - /// The fully qualified name of the member (e.g., `Summary.DocMember`). + /// The fully qualified name of the member (e.g., Summary.DocMember). /// public required string FullyQualifiedName { get; init; } /// - /// The name of the member (e.g. `public int Field` has name `Field`). + /// The name of the member (e.g. public int Field has name Field). /// public required string Name { 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`). + /// (e.g. public int Field is a declaration of the field member Field). /// public required string Declaration { get; init; } @@ -55,7 +55,7 @@ public abstract record DocMember public DocLocation? Location { get; init; } /// - /// Whether this member matches the specified `cref` reference. + /// Whether this member matches the specified cref reference. /// public bool MatchesCref(string cref) { diff --git a/src/Core/DocMethod.cs b/src/Core/DocMethod.cs index 3e5191c..24beb72 100644 --- a/src/Core/DocMethod.cs +++ b/src/Core/DocMethod.cs @@ -23,12 +23,12 @@ public record DocMethod : DocMember public required bool Delegate { get; init; } = false; /// - /// The signature of the method without parameters in link format (e.g., `Sum{T}`). + /// The signature of the method without parameters in link format (e.g., Sum{T}). /// public string SignatureWithoutParams => $"{FullyQualifiedName}{TypeParamsSignature}"; /// - /// The signature of the method in link format (e.g., `Sum{T}(T, T)`). + /// The signature of the method in link format (e.g., Sum{T}(T, T)). /// public string Signature => $"{SignatureWithoutParams}{ParamsSignature}"; diff --git a/src/Core/DocParam.cs b/src/Core/DocParam.cs index d4d7b6b..3aacfc9 100644 --- a/src/Core/DocParam.cs +++ b/src/Core/DocParam.cs @@ -8,7 +8,7 @@ public record DocParam(DocType? Type, string Name) { /// - /// The comment of the parameter (i.e., `<param>` tag). + /// The comment of the parameter (i.e., <param> tag). /// public DocCommentElement? Comment(DocMember parent) => parent.Comment.Param(Name); diff --git a/src/Core/DocType.cs b/src/Core/DocType.cs index d6bae3a..08ff3ed 100644 --- a/src/Core/DocType.cs +++ b/src/Core/DocType.cs @@ -3,7 +3,7 @@ namespace Summary; /// -/// A simple type (e.g. `int`, `string`, `List<int>`, etc.). +/// A simple type (e.g. int, string, List<int>, etc.). /// /// The name of the type (without generic arguments). /// The generic parameters of this type (if it's generic). diff --git a/src/Core/DocTypeDeclaration.cs b/src/Core/DocTypeDeclaration.cs index 10c939b..b441be6 100644 --- a/src/Core/DocTypeDeclaration.cs +++ b/src/Core/DocTypeDeclaration.cs @@ -3,8 +3,8 @@ namespace Summary; /// -/// A that represents a documented type declaration (e.g. `struct`, `class`, etc.) -/// in the parsed source code. +/// A that represents a documented type declaration +/// (e.g. struct, class, etc.) in the parsed source code. /// public record DocTypeDeclaration : DocMember { diff --git a/src/Core/DocTypeParam.cs b/src/Core/DocTypeParam.cs index 45de1a8..edd16ac 100644 --- a/src/Core/DocTypeParam.cs +++ b/src/Core/DocTypeParam.cs @@ -7,7 +7,7 @@ public record DocTypeParam(string Name) { /// - /// The comment of the parameter (i.e., `<typeparam>` tag). + /// The comment of the parameter (i.e., <typeparam> tag). /// public DocCommentElement? Comment(DocMember parent) => parent.Comment.TypeParam(Name); diff --git a/src/Core/Extensions/EnumerableExtensions.cs b/src/Core/Extensions/EnumerableExtensions.cs index 2206d4a..383dfd6 100644 --- a/src/Core/Extensions/EnumerableExtensions.cs +++ b/src/Core/Extensions/EnumerableExtensions.cs @@ -20,13 +20,13 @@ public static string Separated(this IEnumerable self, string with) => string.Join(with, self); /// - /// Filters out all `null` values from the specified sequence. + /// Filters out all null values from the specified sequence. /// public static IEnumerable NonNulls(this IEnumerable self) => self.Where(x => x != null)!; /// - /// Applies the specified `map` function on each element in the specified sequence. + /// Applies the specified map function on each element in the specified sequence. /// Additionally, passes the optional next element. /// public static IEnumerable SelectWithNext(this IEnumerable self, Func map) => diff --git a/src/Core/Extensions/StringExtensions.cs b/src/Core/Extensions/StringExtensions.cs index e183244..0aceb36 100644 --- a/src/Core/Extensions/StringExtensions.cs +++ b/src/Core/Extensions/StringExtensions.cs @@ -33,7 +33,7 @@ public static string AsFullPath(this string self) => Path.GetFullPath(Path.Combine(Environment.CurrentDirectory, self)); /// - /// Converts the given string into the format of `cref` attribute value. + /// Converts the given string into the format of cref attribute value. /// /// /// In the following example, the "Some<T1, T2>" string diff --git a/src/Core/Pipes/PipeExtensions.cs b/src/Core/Pipes/PipeExtensions.cs index bc232d0..a6e963e 100644 --- a/src/Core/Pipes/PipeExtensions.cs +++ b/src/Core/Pipes/PipeExtensions.cs @@ -33,13 +33,13 @@ public static IPipe Then(this IPipe a, IPipe b, bool whe when ? a.Then(b) : a; /// - /// Constructs a new pipe that will apply the specified `select` function to the output of the current pipe. + /// Constructs a new pipe that will apply the specified select function to the output of the current pipe. /// public static IPipe Then(this IPipe a, Func map) => a.Then(new FuncPipe(map)); /// - /// Constructs a new pipe that will apply the specified `select` function to the output of the current pipe. + /// Constructs a new pipe that will apply the specified select function to the output of the current pipe. /// public static IPipe Then(this IPipe a, Func map, bool when) => when ? a.Then(map) : a; diff --git a/src/Core/Pipes/Unit.cs b/src/Core/Pipes/Unit.cs index c39f782..fbc0983 100644 --- a/src/Core/Pipes/Unit.cs +++ b/src/Core/Pipes/Unit.cs @@ -1,7 +1,7 @@ namespace Summary.Pipes; /// -/// A void type that is similar to `void` keyword. +/// A void type that is similar to void keyword. /// public class Unit { diff --git a/src/Core/Samples/Sample.cs b/src/Core/Samples/Sample.cs index 829ad98..9ca6479 100644 --- a/src/Core/Samples/Sample.cs +++ b/src/Core/Samples/Sample.cs @@ -102,19 +102,19 @@ public event Action Event2 /// /// A simple method. /// It contains two parameters: - /// - means `x` - /// - means `y` + /// - means x + /// - means y /// It contains three type parameters: /// - is the first one /// - is the second one /// - is the third one /// - /// The `x` of the method. - /// The `y` of the method. + /// The x of the method. + /// The y of the method. /// The first type parameter of the method. /// The second type parameter of the method. /// The third type parameter of the method. - /// The `TimeSpan` instance. + /// The TimeSpan instance. public TimeSpan Method(int x, string y) => TimeSpan.Zero;