JSDoc Comments

[leandrumartin]

🎯 Goal / Objective

A clear and concise description of what this task aims to achieve. Why is this task important?

Many symbols (functions, classes) in templates/js do not have fully JSDoc-compliant comments, or no documentation comments at all. This makes it difficult to onboard new developers to the project and get people familiar with the project structure. Some documentation comments have a function description but do not have parameters or return values documented.

---

✅ Tasks to be Completed

A checklist of the specific, actionable steps required to complete this issue. This helps track progress.

• Go through each class and function within the templates/js and ensure it has a fully JSDoc-compliant documentation comment.

---

Acceptance Criteria

A checklist of conditions that must be met for this task to be considered complete. How will we verify that it's done correctly?

• Each symbol has a JSDoc-compliant documentation comment. The symbol and its functionality is described, as are parameters and return values.
• At a minimum, the symbol description and the @param and @returns tags are required. Others may be added if deemed appropriate and not too tedious to add, nor too distracting in reading through the file.

---

Additional Context

Add any other context, notes, screenshots, or links that might be helpful for completing this task.

• JSDoc documentation can be found at jsdoc.app.