Merge pull request #50 from candy-kingdom/fix/warnings

Fixed warnings
candy-kingdom · Dec 10, 2023 · 6dad6ca · 6dad6ca
2 parents 87f0255 + bcff8c0
commit 6dad6ca
Show file tree

Hide file tree

Showing 57 changed files with 187 additions and 131 deletions.
diff --git a/docs/CleanupDirPipe{I}.md b/docs/CleanupDirPipe{I}.md
@@ -6,8 +6,10 @@ public class CleanupDirPipe<I> : IPipe<I, I>
 Cleans up a given directory by deleting and re-creating it.
 
 ## Methods
-### [Run(I)](../src/Core/Pipes/IO/CleanupDirPipe.cs#L8)
+### [Run(I)](../src/Core/Pipes/IO/CleanupDirPipe.cs#L9)
 ```cs
 public Task<I> Run(I input)
 ```
 
+Asynchronously processes the specified input and returns the output.
+
diff --git 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 <param>documentation element that has the specified name.
+A nested `<param>` documentation element that has the specified name.
 
 #### Parameters
 - `name`: The name of the parameter to search inside the comment.
@@ -37,7 +37,7 @@ A nested <param>documentation element that has the specified name.
 public DocCommentElement? TypeParam(string name)
 ```
 
-A nested <typeparam>documentation element that has the specified name.
+A nested `<typeparam>` documentation element that has the specified name.
 
 #### Parameters
 - `name`: The name of the parameter to search inside the comment.

diff --git 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/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 (`<paramref>`, `<typeparamref>`).
+A [`DocCommentNode`](./DocCommentNode.md) that represents the reference to a parameter
+(`<paramref>`, `<typeparamref>`).
 
 ## 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
@@ -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/docs/FilterMemberPipe.md b/docs/FilterMemberPipe.md
@@ -6,8 +6,10 @@ public class FilterMemberPipe : IPipe<Doc, Doc>
 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<Doc> Run(Doc input)
 ```
 
+Asynchronously processes the specified input and returns the output.
+
diff --git a/docs/FoldPipe{O}.md b/docs/FoldPipe{O}.md
@@ -6,8 +6,10 @@ public class FoldPipe<O> : IPipe<O[], O>
 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<O> 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
@@ -6,8 +6,10 @@ public class FuncPipe<I, O> : IPipe<I, O>
 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<O> Run(I input)
 ```
 
+Asynchronously processes the specified input and returns the output.
+
diff --git 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
@@ -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,36 +36,36 @@ 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
 ```
 
 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
 ```
 
 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<T>(byte, byte)](../src/Core/Samples/InheritDocSample.cs#L73)
+### [Sum<T>(byte, byte)](../src/Core/Samples/InheritDocSample.cs#L83)
 ```cs
 public byte Sum<T>(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
@@ -1,12 +1,12 @@
-# [Summary.Samples.InheritDocRecordBase](../src/Core/Samples/InheritDocSample.cs#L194)
+# [Summary.Samples.InheritDocRecordBase](../src/Core/Samples/InheritDocSample.cs#L204)
 ```cs
 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
@@ -1,19 +1,19 @@
-# [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)
 ```
 
 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
@@ -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,15 +8,15 @@ Summary.
 _Remarks section._
 
 ## Events
-### [Event1](../src/Core/Samples/InheritDocSample.cs#L98)
+### [Event1](../src/Core/Samples/InheritDocSample.cs#L108)
 ```cs
 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)
 ```