Skip to content

Commit af68552

Browse files
committed
Game: Corrected return values in documentation
1 parent 5cdaa07 commit af68552

File tree

4 files changed

+6
-6
lines changed

4 files changed

+6
-6
lines changed

Documentation/Game.Bomb.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,4 @@ public static System.Func<GameObject,object> Bomb { get; }
1111
[System.NotSupportedException](https://docs.microsoft.com/en-us/dotnet/api/System.NotSupportedException 'System.NotSupportedException')
1212
[UnrecognizedValueException](UnrecognizedValueException.md 'KeepCoding.Internal.UnrecognizedValueException')
1313
### Remarks
14-
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').
14+
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').

Documentation/Game.Timer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,4 @@ public static System.Func<GameObject,object> Timer { get; }
1111
[System.NotSupportedException](https://docs.microsoft.com/en-us/dotnet/api/System.NotSupportedException 'System.NotSupportedException')
1212
[UnrecognizedValueException](UnrecognizedValueException.md 'KeepCoding.Internal.UnrecognizedValueException')
1313
### Remarks
14-
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').
14+
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').

Documentation/Game.Vanillas.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,4 @@ public static System.Func<KMBomb,object[]> Vanillas { get; }
1111
[System.NotSupportedException](https://docs.microsoft.com/en-us/dotnet/api/System.NotSupportedException 'System.NotSupportedException')
1212
[UnrecognizedValueException](UnrecognizedValueException.md 'KeepCoding.Internal.UnrecognizedValueException')
1313
### Remarks
14-
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').
14+
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').

Source/Statics/Game.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -779,7 +779,7 @@ public enum References
779779
/// 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.
780780
/// </summary>
781781
/// <remarks>
782-
/// Default: <see langword="null"/>.
782+
/// Default: An encapsulated method that takes a <see cref="GameObject"/> and always returns <see langword="null"/>.
783783
/// </remarks>
784784
/// <exception cref="NotSupportedException"></exception>
785785
/// <exception cref="UnrecognizedValueException"></exception>
@@ -799,7 +799,7 @@ public enum References
799799
/// 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.
800800
/// </summary>
801801
/// <remarks>
802-
/// Default: <see langword="null"/>.
802+
/// Default: An encapsulated method that takes a <see cref="GameObject"/> and always returns <see langword="null"/>.
803803
/// </remarks>
804804
/// <exception cref="NotSupportedException"></exception>
805805
/// <exception cref="UnrecognizedValueException"></exception>
@@ -819,7 +819,7 @@ public enum References
819819
/// 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.
820820
/// </summary>
821821
/// <remarks>
822-
/// Default: An empty <see cref="object"/> <see cref="Array"/>.
822+
/// Default: An encapsulated method that takes a <see cref="GameObject"/> and always returns an empty <see cref="object"/> <see cref="Array"/>.
823823
/// </remarks>
824824
/// <exception cref="NotSupportedException"></exception>
825825
/// <exception cref="UnrecognizedValueException"></exception>

0 commit comments

Comments
 (0)