Files
2025-11-29 17:54:51 +08:00

808 B

Generate comprehensive documentation for the specified code. Include:

  1. Overview

    • Purpose and functionality
    • Key features
    • Use cases
  2. API Documentation

    • Function/method signatures
    • Parameter descriptions with types
    • Return values
    • Exceptions/errors that may be thrown
  3. Usage Examples

    • Basic usage examples
    • Advanced use cases
    • Common patterns
  4. Configuration

    • Required environment variables
    • Configuration options
    • Default values
  5. Dependencies

    • Required libraries
    • Version requirements
    • Installation instructions
  6. Additional Notes

    • Known limitations
    • Performance considerations
    • Best practices

Format the documentation in clear, professional markdown suitable for a README or API reference.