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;