Game: Corrected return values in documentation

Emik03 · Aug 21, 2021 · af68552 · af68552
1 parent 5cdaa07
commit af68552
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 6 deletions.
diff --git a/Documentation/Game.Bomb.md b/Documentation/Game.Bomb.md
@@ -11,4 +11,4 @@ public static System.Func<GameObject,object> Bomb { get; }
 [System.NotSupportedException](https://docs.microsoft.com/en-us/dotnet/api/System.NotSupportedException 'System.NotSupportedException')  
 [UnrecognizedValueException](UnrecognizedValueException.md 'KeepCoding.Internal.UnrecognizedValueException')  
 ### Remarks
-Default: [null](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/null 'https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/null').  
+Default: An encapsulated method that takes a [UnityEngine.GameObject](https://docs.microsoft.com/en-us/dotnet/api/UnityEngine.GameObject 'UnityEngine.GameObject') and always returns [null](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/null 'https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/null').  
diff --git a/Documentation/Game.Timer.md b/Documentation/Game.Timer.md
@@ -11,4 +11,4 @@ public static System.Func<GameObject,object> Timer { get; }
 [System.NotSupportedException](https://docs.microsoft.com/en-us/dotnet/api/System.NotSupportedException 'System.NotSupportedException')  
 [UnrecognizedValueException](UnrecognizedValueException.md 'KeepCoding.Internal.UnrecognizedValueException')  
 ### Remarks
-Default: [null](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/null 'https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/null').  
+Default: An encapsulated method that takes a [UnityEngine.GameObject](https://docs.microsoft.com/en-us/dotnet/api/UnityEngine.GameObject 'UnityEngine.GameObject') and always returns [null](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/null 'https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/null').  
diff --git a/Documentation/Game.Vanillas.md b/Documentation/Game.Vanillas.md
@@ -11,4 +11,4 @@ public static System.Func<KMBomb,object[]> Vanillas { get; }
 [System.NotSupportedException](https://docs.microsoft.com/en-us/dotnet/api/System.NotSupportedException 'System.NotSupportedException')  
 [UnrecognizedValueException](UnrecognizedValueException.md 'KeepCoding.Internal.UnrecognizedValueException')  
 ### Remarks
-Default: An empty [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object')[System.Array](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array').  
+Default: An encapsulated method that takes a [UnityEngine.GameObject](https://docs.microsoft.com/en-us/dotnet/api/UnityEngine.GameObject 'UnityEngine.GameObject') and always returns an empty [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object')[System.Array](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array').  
diff --git a/Source/Statics/Game.cs b/Source/Statics/Game.cs
@@ -779,7 +779,7 @@ public enum References
         /// Gets the game's internal bomb component, not to be mistaken with <see cref="KMBomb"/>. To prevent a reference to the game, the type is boxed in <see cref="object"/>. You can cast it to Bomb or <see cref="MonoBehaviour"/> type to restore its functionality.
         /// </summary>
         /// <remarks>
-        /// Default: <see langword="null"/>.
+        /// Default: An encapsulated method that takes a <see cref="GameObject"/> and always returns <see langword="null"/>.
         /// </remarks>
         /// <exception cref="NotSupportedException"></exception>
         /// <exception cref="UnrecognizedValueException"></exception>
@@ -799,7 +799,7 @@ public enum References
         /// Gets the game's internal timer component. To prevent a reference to the game, the type is boxed in <see cref="object"/>. You can cast it to TimerComponent or <see cref="MonoBehaviour"/> type to restore its functionality.
         /// </summary>
         /// <remarks>
-        /// Default: <see langword="null"/>.
+        /// Default: An encapsulated method that takes a <see cref="GameObject"/> and always returns <see langword="null"/>.
         /// </remarks>
         /// <exception cref="NotSupportedException"></exception>
         /// <exception cref="UnrecognizedValueException"></exception>
@@ -819,7 +819,7 @@ public enum References
         /// Gets all of the vanilla modules from the bomb supplied, including needies. To prevent a reference to the game, the type is boxed in an <see cref="object"/> <see cref="Array"/>. You can cast it to BombComponent type to restore its functionality.
         /// </summary>
         /// <remarks>
-        /// Default: An empty <see cref="object"/> <see cref="Array"/>.
+        /// Default: An encapsulated method that takes a <see cref="GameObject"/> and always returns an empty <see cref="object"/> <see cref="Array"/>.
         /// </remarks>
         /// <exception cref="NotSupportedException"></exception>
         /// <exception cref="UnrecognizedValueException"></exception>