From 53f046f7f0dacd7b0c3db8456104d829958c2edf Mon Sep 17 00:00:00 2001
From: 100gle <loogle.space@gmail.com>
Date: Sun, 24 Dec 2023 20:47:22 +0800
Subject: [PATCH] feat: Add type hints for js function by JSDoc

---
 templates/components/challenge_area.html    | 8 ++++++++
 templates/components/challenge_sidebar.html | 5 +++++
 2 files changed, 13 insertions(+)

diff --git a/templates/components/challenge_area.html b/templates/components/challenge_area.html
index fc5ef41..df14218 100644
--- a/templates/components/challenge_area.html
+++ b/templates/components/challenge_area.html
@@ -49,6 +49,14 @@
 </div>
 
 <script type="text/javascript">
+  /**
+   * Render the code area with CodeMirror and Jinja2.
+   *
+   * @param {string} code_under_test - The code to be tested.
+   * @param {string} test_code - The test code.
+   * @param {'basic'|'intermediate'|'advanced'|'extreme'} level - The level of the challenge.
+   * @param {string} name - The name of the challenge.
+   */
   function renderCodeArea(code_under_test, test_code, level, name) {
     let confetti = new JSConfetti();
     let initTheme = localStorage.getItem('theme') === 'dark' ? "material-darker" : "default"
diff --git a/templates/components/challenge_sidebar.html b/templates/components/challenge_sidebar.html
index 188d5c9..0886f2e 100644
--- a/templates/components/challenge_sidebar.html
+++ b/templates/components/challenge_sidebar.html
@@ -134,6 +134,11 @@ <h5 class="challenge-level">{{ level }}</h5>
     });
   });
 
+  /**
+   * Remove previously highlighted style from the challenge list.
+   *
+   * @param {Event} event - The click event.
+   */
   function removeHighlight(event) {
     previousActiveChallenges = document.getElementsByClassName("active-challenge");
     for (c of previousActiveChallenges) {