Add JSDoc Comments to Public Functions

[pie111]

The current codebase lacks comprehensive JSDoc comments for public functions, making it difficult to understand their purpose, parameters, and return values. This can hinder code maintainability, readability, and collaboration.

Desired Behavior:

All public functions should be documented with clear and concise JSDoc comments, including:

• Function Description: A brief explanation of the function's purpose.
• Parameters: A description of each parameter, including its type and expected value.
• Return Value: A description of the return value, including its type and meaning.
• Example Usage: A code example demonstrating how to use the function.