Merge pull request #10 from Pogromca-SCP/docs-fix

Fixed in-code documentation

CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.0.2]- 2024-11-21
+
+### Fixed
+
+- Fixed invalid or missing in-code documentation.
+
 ## [1.0.1] - 2024-10-18
 
 ### Fixed

SLCommandScript.Core/Constants.cs

@@ -13,7 +13,7 @@ public static class Constants
     /// <summary>
     /// Contains current project version.
     /// </summary>
-    public const string ProjectVersion = "1.0.1";
+    public const string ProjectVersion = "1.0.2";
 
     /// <summary>
     /// Contains project author.

SLCommandScript.Core/Iterables/ListIterable.cs

@@ -103,7 +103,7 @@ public ListIterable(Func<IEnumerable<TItem>> source, Action<IDictionary<string,
     /// <summary>
     /// Creates new predefined list iterable.
     /// </summary>
-    /// <param name="item">Objects to insert into wrapped list.</param>
+    /// <param name="items">Objects to insert into wrapped list.</param>
     /// <param name="mapper">Variable mapper to use to load variables.</param>
     public ListIterable(IEnumerable<TItem> items, Action<IDictionary<string, string>, TItem> mapper)
     {

SLCommandScript.Core/Iterables/Providers/Ranges.cs

@@ -21,7 +21,7 @@ public static IIterable StandardRange(int start, int end) =>
     /// Loads number value and inserts it into a dictionary.
     /// </summary>
     /// <param name="targetVars">Dictionary to insert value into.</param>
-    /// <param name="player">Number value to load.</param>
+    /// <param name="number">Number value to load.</param>
     /// <exception cref="NullReferenceException">When provided object is <see langword="null"/>.</exception>
     public static void LoadVariables(IDictionary<string, string> targetVars, int number) => targetVars["i"] = number.ToString();
 

SLCommandScript.Core/Language/Parser.cs

@@ -128,7 +128,7 @@ public Expr Parse(IList<Token> tokens)
     /// <summary>
     /// Attempts to match specific token type.
     /// </summary>
-    /// <param name="types">Token type to match.</param>
+    /// <param name="type">Token type to match.</param>
     /// <returns><see langword="true" /> if token type was matched, <see langword="false" /> otherwise.</returns>
     private bool Match(TokenType type)
     {

SLCommandScript.Core/Language/TokenType.cs

@@ -5,18 +5,73 @@
 /// </summary>
 public enum TokenType : byte
 {
+    /// <summary>
+    /// Empty token type for technical purposes.
+    /// </summary>
     None,
+
+    /// <summary>
+    /// [
+    /// </summary>
     LeftSquare,
+
+    /// <summary>
+    /// ]
+    /// </summary>
     RightSquare,
+
+    /// <summary>
+    /// #?
+    /// </summary>
     ScopeGuard,
+
+    /// <summary>
+    /// $(variable_name)
+    /// </summary>
     Variable,
+
+    /// <summary>
+    /// Represents any text value not matching other token types.
+    /// </summary>
     Text,
+
+    /// <summary>
+    /// -?[0-9]*
+    /// </summary>
     Number,
+
+    /// <summary>
+    /// NUMBER%
+    /// </summary>
     Percentage,
+
+    /// <summary>
+    /// if
+    /// </summary>
     If,
+
+    /// <summary>
+    /// else
+    /// </summary>
     Else,
+
+    /// <summary>
+    /// foreach
+    /// </summary>
     Foreach,
+
+    /// <summary>
+    /// delayby
+    /// </summary>
     DelayBy,
+
+    /// <summary>
+    /// forrandom
+    /// </summary>
     ForRandom,
+
+    /// <summary>
+    /// |
+    /// </summary>
     Sequence
 }

SLCommandScript.Core/SLCommandScript.Core.csproj

@@ -30,7 +30,7 @@
 		<EnablePackageValidation>true</EnablePackageValidation>
 		<Title>SLCommandScript.Core</Title>
 		<Copyright>Copyright © 2023-present Adam Szerszenowicz</Copyright>
-		<PackageVersion>1.0.1</PackageVersion>
+		<PackageVersion>1.0.2</PackageVersion>
 		<PackageValidationBaselineVersion>1.0.0</PackageValidationBaselineVersion>
 	</PropertyGroup>
 	<ItemGroup>

SLCommandScript/Plugin.cs

@@ -21,7 +21,7 @@ public class Plugin
     /// <summary>
     /// Contains current plugin version.
     /// </summary>
-    public const string PluginVersion = "1.0.1";
+    public const string PluginVersion = "1.0.2";
 
     /// <summary>
     /// Contains plugin description.