Skip to content

Conversation

@continue
Copy link

@continue continue bot commented Oct 21, 2025

Summary

This PR adds comprehensive JSDoc documentation to all functions, methods, classes, and enums in src/helpers/logger.ts.

Changes

  • ✅ Added JSDoc comments to LogLevel enum with description
  • ✅ Added JSDoc comments to Logger class with usage example
  • ✅ Documented all public methods: debug(), info(), warn(), error(), setLevel(), getLevel()
  • ✅ Documented private methods: formatMessage(), shouldLog()
  • ✅ Added documentation for exported functions: createLogger(), parseLogLevel(), formatError()
  • ✅ Included parameter descriptions and return types for all functions
  • ✅ Added usage examples where appropriate

Documentation Coverage

  • Enum: 1/1 documented (LogLevel)
  • Class: 1/1 documented (Logger)
  • Methods: 8/8 documented (all Logger methods)
  • Functions: 3/3 documented (all exported functions)

All functions now have:

  • Parameter descriptions with types
  • Return type documentation
  • Practical usage examples
  • Clear descriptions of behavior

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

- Add JSDoc for Logger class and all its methods
- Document LogLevel enum with description
- Add parameter descriptions and return types for all functions
- Include usage examples for all public APIs
- Document private methods with @Private tag

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

Co-authored-by: bekah-hawrot-weigel <[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