Skip to content

Conversation

@continue
Copy link

@continue continue bot commented Oct 21, 2025

πŸ“ Documentation Enhancement

This PR adds comprehensive JSDoc comments to all public APIs in the src/helpers/logger.ts module.

Changes Made

  • βœ… Added JSDoc comments to the LogLevel enum with descriptions for each level
  • βœ… Documented the Logger class with full parameter and return type information
  • βœ… Added usage examples to all public methods (debug, info, warn, error)
  • βœ… Documented private methods for completeness
  • βœ… Added documentation to factory function createLogger
  • βœ… Documented utility functions parseLogLevel and formatError
  • βœ… Included proper JSDoc tags: @module, @class, @enum, @param, @returns, @example

Documentation Highlights

All public APIs now include:

  • Parameter descriptions with types
  • Return type documentation
  • Usage examples demonstrating typical use cases
  • Clear explanations of behavior and purpose

Example

/**
 * Logs an error message with optional Error object.
 * @param {string} message - The error message to log
 * @param {Error} [error] - Optional Error object to log with stack trace
 * @example
 * logger.error('Failed to connect', new Error('Connection refused'));
 */
error(message: string, error?: Error): void

This agent session was co-authored by bekah-hawrot-weigel and Continue.

- Added JSDoc comments to LogLevel enum with descriptions for each level
- Documented Logger class with full parameter and return type info
- Added usage examples to all public methods
- Documented factory functions and utility functions
- Included @module, @Class, @enum, @param, @returns tags

Co-authored-by: [email protected]
Generated with [Continue](https://continue.dev)

Co-Authored-By: Continue <[email protected]>
@BekahHW BekahHW closed this Oct 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants