Skip to content

Conversation

@continue
Copy link

@continue continue bot commented Oct 21, 2025

Changes

This PR adds comprehensive JSDoc documentation to the Logger class and all related functions in src/helpers/logger.ts.

What was added:

  • LogLevel enum: Documented each log level (DEBUG, INFO, WARN, ERROR) with descriptions
  • Logger class: Added class-level JSDoc documentation
  • Constructor: Documented parameters with default values and usage example
  • Private methods:
    • formatMessage: Documents message formatting logic
    • shouldLog: Documents log level checking logic
  • Public logging methods:
    • debug: With usage example
    • info: With usage example
    • warn: With usage example
    • error: With usage example and Error parameter documentation
  • Getter/Setter methods:
    • setLevel: With usage example
    • getLevel: With return type documentation
  • Helper functions:
    • createLogger: Factory function with usage example
    • parseLogLevel: String parser with examples
    • formatError: Error formatter with try/catch example

All documentation includes:

  • Parameter types and descriptions
  • Return types
  • Usage examples where appropriate
  • Clear explanations of what each method does

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

- Added JSDoc comments to all methods in Logger class
- Documented LogLevel enum with descriptions for each level
- Added parameter descriptions and return types for all functions
- Included usage examples for public methods
- Documented helper functions: createLogger, parseLogLevel, formatError

Generated with [Continue](https://continue.dev)

Co-Authored-By: Continue <[email protected]>
Co-authored-by: [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.

3 participants