From 0d76c2f24373e44153359334b11790646fe7f396 Mon Sep 17 00:00:00 2001 From: neogeek Date: Sat, 31 Aug 2019 15:14:59 -0400 Subject: [PATCH] Updated documentation. --- Scripts/Animate.cs | 2 +- Scripts/CustomExtensions.cs | 8 ++++---- Scripts/Debugger.cs | 16 ++++++++-------- Scripts/InputManager.cs | 10 +++++----- Scripts/Runner.cs | 4 ++-- Scripts/ScriptableObjects/AudioPoolReference.cs | 2 +- Scripts/Structs.cs | 6 +++--- 7 files changed, 24 insertions(+), 24 deletions(-) diff --git a/Scripts/Animate.cs b/Scripts/Animate.cs index 604eb5a9..d9c0011d 100644 --- a/Scripts/Animate.cs +++ b/Scripts/Animate.cs @@ -134,7 +134,7 @@ public static Coroutine Fade(GameObject gameObject, float from, float to) /// GameObject to move. /// New Vector3 position. /// Length of the animation in seconds. - /// Coordinate system to animate with. + /// Coordinate system used to animate the gameObject. /// Coroutine public static Coroutine MoveTo(GameObject gameObject, Vector3 newPosition, float duration, Space relativeTo) { diff --git a/Scripts/CustomExtensions.cs b/Scripts/CustomExtensions.cs index 0c53a3a6..95fa98a6 100644 --- a/Scripts/CustomExtensions.cs +++ b/Scripts/CustomExtensions.cs @@ -115,7 +115,7 @@ public static bool Contains(this int mask, int value) /// /// AnimationCurve object. /// Key of keyframe to modify. - /// Value to update keyframe with. + /// Value used to update keyframe. /// void public static void EditKeyframeValue(this AnimationCurve animationCurve, int key, float value) { @@ -133,7 +133,7 @@ public static void EditKeyframeValue(this AnimationCurve animationCurve, int key /// /// Vector3AnimationCurve object. /// Key of each keyframe to modify. - /// Vector3 to update each corresponding keyframe with. + /// Vector3 used to update each corresponding keyframe. /// void public static void EditKeyframeValue(this Vector3AnimationCurve animationCurve, int key, Vector3 vector) { @@ -149,7 +149,7 @@ public static void EditKeyframeValue(this Vector3AnimationCurve animationCurve, /// /// Vector2AnimationCurve object. /// Key of each keyframe to modify. - /// Vector2 to update each corresponding keyframe with. + /// Vector2 used to update each corresponding keyframe. /// void public static void EditKeyframeValue(this Vector2AnimationCurve animationCurve, int key, Vector2 vector) { @@ -281,7 +281,7 @@ public static float MaxTime(this AnimationCurve animationCurve) /// /// The first number in the comparison. /// The second number in the comparison. - /// The custom epsilon to compare with. + /// The custom epsilon used to compare numbers. /// bool public static bool NearlyEqual(this float num1, float num2, float epsilon) { diff --git a/Scripts/Debugger.cs b/Scripts/Debugger.cs index 15c80ba8..7a4c852e 100644 --- a/Scripts/Debugger.cs +++ b/Scripts/Debugger.cs @@ -12,7 +12,7 @@ public static class Debugger /// /// Draws an array of vectors with Unity's Debug.DrawLine method. /// - /// Array of Vector3 objects to render lines with. + /// Array of Vector3 objects used to render lines. /// Color of lines. /// Duration lines remains visible. /// Should lines be obscured with objects closer to camera? @@ -32,7 +32,7 @@ public static void DrawLines(Vector3[] points, Color color, float duration, bool /// /// Draws an array of vectors with Unity's Debug.DrawLine method. /// - /// Array of Vector3 objects to render lines with. + /// Array of Vector3 objects used to render lines. /// Color of lines. /// Duration lines remains visible. /// void @@ -46,7 +46,7 @@ public static void DrawLines(Vector3[] points, Color color, float duration) /// /// Draws an array of vectors with Unity's Debug.DrawLine method. /// - /// Array of Vector3 objects to render lines with. + /// Array of Vector3 objects used to render lines. /// Color of lines. /// void public static void DrawLines(Vector3[] points, Color color) @@ -59,7 +59,7 @@ public static void DrawLines(Vector3[] points, Color color) /// /// Draws a list of vectors with Unity's Debug.DrawLine method. /// - /// List of Vector3 objects to render lines with. + /// List of Vector3 objects used to render lines. /// Color of lines. /// Duration lines remains visible. /// Should lines be obscured with objects closer to camera? @@ -74,7 +74,7 @@ public static void DrawLines(List points, Color color, float duration, /// /// Draws a list of vectors with Unity's Debug.DrawLine method. /// - /// List of Vector3 objects to render lines with. + /// List of Vector3 objects used to render lines. /// Color of lines. /// Duration lines remains visible. /// void @@ -88,7 +88,7 @@ public static void DrawLines(List points, Color color, float duration) /// /// Draws a list of vectors with Unity's Debug.DrawLine method. /// - /// List of Vector3 objects to render lines with. + /// List of Vector3 objects used to render lines. /// Color of lines. /// void public static void DrawLines(List points, Color color) @@ -101,7 +101,7 @@ public static void DrawLines(List points, Color color) /// /// Draws an array of vectors with Unity's Debug.DrawLine method. /// - /// Array of Vector3 objects to render lines with. + /// Array of Vector3 objects used to render lines. /// void public static void DrawLines(Vector3[] points) { @@ -113,7 +113,7 @@ public static void DrawLines(Vector3[] points) /// /// Draws a list of vectors with Unity's Debug.DrawLine method. /// - /// List of Vector3 objects to render lines with. + /// List of Vector3 objects used to render lines. /// void public static void DrawLines(List points) { diff --git a/Scripts/InputManager.cs b/Scripts/InputManager.cs index 26b25907..ef97ed23 100644 --- a/Scripts/InputManager.cs +++ b/Scripts/InputManager.cs @@ -332,7 +332,7 @@ public static bool GetMouseButtonUp() /// Returns the active touch based on a unique finger ID and a TouchPhase enum filter. /// /// The stored unique finger ID of the touch event. - /// TouchPhase enums to filter with. + /// TouchPhase enums used to filter. /// Touch public static Touch? GetActiveTouch(int fingerId, params TouchPhase[] touchPhasesFilter) { @@ -361,7 +361,7 @@ public static bool GetMouseButtonUp() /// /// Returns the active touch based on a TouchPhase enum filter. /// - /// TouchPhase enums to filter with. + /// TouchPhase enums used to filter. /// Touch public static Touch? GetActiveTouch(params TouchPhase[] touchPhasesFilter) { @@ -645,7 +645,7 @@ public static bool GetTouchUp() /// /// GameObject to test. /// Current active camera. - /// Vector3 to test raycast with. + /// Vector3 used to test raycast. /// The result of the raycast. /// bool public static bool RaycastToGameObject(GameObject gameObject, Camera mainCamera, Vector3 position, @@ -655,7 +655,7 @@ public static bool GetTouchUp() var ray = mainCamera.ScreenPointToRay(position); return Physics.Raycast(ray, out hit, Mathf.Infinity, gameObject.GetLayerMask()) && - hit.transform.IsChildOf(gameObject.transform); + hit.transform.IsChildOf(gameObject.transform); } @@ -664,7 +664,7 @@ public static bool GetTouchUp() /// /// GameObject to test. /// Current active camera. - /// Vector3 to test raycast with. + /// Vector3 used to test raycast. /// The result of the raycast. /// bool public static bool RaycastToGameObject(GameObject gameObject, Camera mainCamera, Vector3 position, diff --git a/Scripts/Runner.cs b/Scripts/Runner.cs index c33a855e..d760c4dc 100644 --- a/Scripts/Runner.cs +++ b/Scripts/Runner.cs @@ -17,8 +17,8 @@ public class Runner : MonoBehaviour /// /// Starts and adds a coroutine to a list. /// - /// Unique key to store coroutine with. - /// IEnumerator to start coroutine with. + /// Unique key used to store coroutine. + /// IEnumerator used to start coroutine. /// Coroutine public Coroutine AddCoroutine(string coroutineKey, IEnumerator routine) { diff --git a/Scripts/ScriptableObjects/AudioPoolReference.cs b/Scripts/ScriptableObjects/AudioPoolReference.cs index e3036d6f..99ec287d 100644 --- a/Scripts/ScriptableObjects/AudioPoolReference.cs +++ b/Scripts/ScriptableObjects/AudioPoolReference.cs @@ -96,7 +96,7 @@ protected override AudioSource Create() /// Plays an audio clip stored in the audio data array by name with a specified AudioSource component. /// /// String representing the audio clip to play. - /// AudioSource component to play an AudioClip with. + /// AudioSource component used to play an AudioClip. /// void public void Play(string audioDataName, AudioSource audioSource) { diff --git a/Scripts/Structs.cs b/Scripts/Structs.cs index 9580fc7a..a4964f1c 100644 --- a/Scripts/Structs.cs +++ b/Scripts/Structs.cs @@ -77,7 +77,7 @@ public bool Equals(Vector2AnimationCurve other) /// /// Evaluates both animation curves and generates a Vector2 with the results. /// - /// The time to evaluate each animation curve with. + /// The time used to evaluate each animation curve. /// Vector2 public Vector2 Evaluate(float time) { @@ -180,7 +180,7 @@ public bool Equals(Vector3AnimationCurve other) /// /// Evaluates all animation curves and generates a Vector3 with the results. /// - /// The time to evaluate each animation curve with. + /// The time used to evaluate each animation curve. /// Vector3 public Vector3 Evaluate(float time) { @@ -297,7 +297,7 @@ public bool Equals(Vector4AnimationCurve other) /// /// Evaluates all animation curves and generates a Vector4 with the results. /// - /// The time to evaluate each animation curve with. + /// The time used to evaluate each animation curve. /// Vector4 public Vector4 Evaluate(float time) {