docs: update

Author: jcs090218

Assets/JCSUnity/Scripts/JCS_Constants.cs

@@ -16,10 +16,10 @@ public static class JCS_Constants
     {
         /* Variables */
 
-        // Minimum friction value.
+        // The minimum friction value.
         public const float FRICTION_MIN = 0.01f;
 
-        // Default effect friction.
+        // The default effect friction value.
         public const float FRICTION = 0.2f;
 
         // Below this threshold is consider close enough.

Assets/JCSUnity/Scripts/UI/JCS_Canvas.cs

@@ -60,11 +60,11 @@ public class JCS_Canvas : MonoBehaviour
 
         [Separator("Runtime Variables (JCS_Canvas)")]
 
-        [Tooltip("Fade canvas by default.")]
+        [Tooltip("Turn on when you want to fade the canvas by default.")]
         [SerializeField]
         private bool mFade = false;
 
-        [Tooltip("Fade friction.")]
+        [Tooltip("How fast the canvas fades.")]
         [SerializeField]
         [Range(0.0001f, 30.0f)]
         private float mFadeFriction = 0.2f;
@@ -84,7 +84,7 @@ public class JCS_Canvas : MonoBehaviour
 
         private JCS_FadeType mFading = JCS_FadeType.IN;
 
-        [Tooltip("Time type.")]
+        [Tooltip("The time type.")]
         [SerializeField]
         private JCS_TimeType mTimeType = JCS_TimeType.UNSCALED_DELTA_TIME;
 

docs/ScriptReference/JCS_Constants.md

@@ -1,3 +1,11 @@
 # JCS_Constants
 
 Place general game constant here.
+
+## Variables
+
+| Name           | Description                                    |
+|:---------------|:-----------------------------------------------|
+| FRICTION_MIN   | The minimum friction value.                    |
+| FRICTION       | The default effect friction value.             |
+| NEAR_THRESHOLD | Below this threshold is consider close enough. |

docs/ScriptReference/UI/JCS_Canvas.md

@@ -4,14 +4,21 @@ Control of the canvas component.
 
 ## Variables
 
-| Name            | Description                                      |
-|:----------------|:-------------------------------------------------|
-| onShow          | Execution when canvas is shown.                  |
-| onHide          | Execution when canvas is hidden.                 |
-| mDisplayOnAwake | If true, show on awake time; otherwise, hide it. |
-| mMainCanvas     | Resizable screen will be attach to this canvas.  |
-| mActiveSound    | Play sound when active the canvas.               |
-| mDeactiveSound  | Play sound when deactive the canvas.             |
+| Name            | Description                                          |
+|:----------------|:-----------------------------------------------------|
+| onShow          | Execution when canvas is shown.                      |
+| onHide          | Execution when canvas is hidden.                     |
+| onShowFade      | Execution when canvas is shown by fading.            |
+| onHideFade      | Execution when canvas is hidden by fading.           |
+| mDisplayOnAwake | If true, show on awake time; otherwise, hide it.     |
+| mMainCanvas     | Resizable screen will be attach to this canvas.      |
+| mFade           | Turn on when you want to fade the canvas by default. |
+| mFadeFriction   | How fast the canvas fades.                           |
+| mFadeInAmount   | The full fade in amount of alpha.                    |
+| mFadeOutAmount  | The full fade out amount of alpha.                   |
+| mTimeType       | The time type.                                       |
+| mActiveSound    | Play sound when active the canvas.                   |
+| mDeactiveSound  | Play sound when deactive the canvas.                 |
 
 ## Functions