docs

Documentation Generator

Generate documentation for: $ARGUMENTS

Target Selection

If $ARGUMENTS is empty:

• Generate/update README.md
• Update API documentation
• Check for missing docstrings

If $ARGUMENTS is a file:

• Generate docstrings for all public functions/classes
• Create/update corresponding docs

If $ARGUMENTS is --api:

• Generate API endpoint documentation
• Create OpenAPI/Swagger spec if applicable

Documentation Types

1. Function/Method Docstrings

Python (Google style):

def process_payment(amount: float, currency: str = "USD") -> PaymentResult:
    """Process a payment transaction.

    Args:
        amount: The payment amount in the smallest currency unit.
        currency: ISO 4217 currency code. Defaults to "USD".

    Returns:
        PaymentResult containing transaction ID and status.

    Raises:
        PaymentError: If the payment fails.
        ValidationError: If amount is negative.

    Example:
        >>> result = process_payment(1000, "EUR")
        >>> print(result.transaction_id)
        'txn_abc123'
    """

TypeScript (JSDoc):

/**
 * Process a payment transaction.
 * 
 * @param amount - The payment amount in cents
 * @param currency - ISO 4217 currency code
 * @returns Promise resolving to PaymentResult
 * @throws {PaymentError} If the payment fails
 * 
 * @example
 * const result = await processPayment(1000, 'EUR');
 * console.log(result.transactionId);
 */

Go:

// ProcessPayment handles a payment transaction.
//
// It accepts the amount in the smallest currency unit and an optional
// currency code (defaults to "USD").
//
// Returns a PaymentResult or an error if the payment fails.
func ProcessPayment(amount int64, currency string) (*PaymentResult, error) {

2. Class/Module Documentation

"""User authentication and session management.

This module provides:
- User login/logout functionality
- Session token generation and validation  
- Password hashing and verification

Typical usage:
    from auth import AuthService
    
    auth = AuthService()
    token = auth.login(username, password)
    user = auth.validate_token(token)

Security Notes:
    - Tokens expire after 24 hours
    - Failed logins are rate-limited
    - Passwords are hashed with bcrypt
"""