/document

Document Tradovate Indicator

Generate documentation for a Tradovate JavaScript indicator. Arguments: $ARGUMENTS

Documentation Modes

--format md (Default)

Generate a separate README.md file with:

• Indicator overview
• Parameter documentation
• Usage examples
• Trading interpretation

--format inline

Add documentation comments to the source code:

• JSDoc comments
• Parameter descriptions
• Method documentation

Documentation Process

1. Read the indicator file completely
2. Extract name and description from exports
3. Document all params with types and defaults
4. Explain calculation logic
5. Document all plots
6. Generate output in requested format

Output Format (Markdown)

# [Indicator Name]

[Brief description from module.exports.description]

## Overview

[2-3 sentences about what the indicator does and when to use it]

## Parameters

| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| period | int | 14 | Lookback period for calculation |
| multiplier | float | 1.0 | Multiplier for bands |

## Plots

| Plot | Description |
|------|-------------|
| vwap | Volume-weighted average price |
| upper | Upper standard deviation band |

## Calculation

[Plain English explanation of the calculation]

## Trading Signals

| Signal | Condition | Interpretation |
|--------|-----------|----------------|
| Bullish | Price > VWAP | Above average price |
| Bearish | Price < VWAP | Below average price |

## Example Usage

1. Add indicator to chart
2. Configure [parameters] for your timeframe
3. Look for [signals]

## Author

Luther Barnum

## Version History

- v1.0.0: Initial release

Inline Documentation Format

/**
 * [Indicator Name]
 * @description [Brief description]
 * @author Luther Barnum
 * @version 1.0.0
 */
class MyIndicator {
    /**
     * Initialize indicator helpers
     * Called once when indicator is loaded
     */
    init() {
        // ...
    }

    /**
     * Calculate values for current bar
     * @param {Object} d - Current bar data
     * @param {number} i - Bar index
     * @param {Object} history - Historical data access
     * @returns {Object} Plot values
     */
    map(d, i, history) {
        // ...
    }
}

File Location

Default search path: /Users/lgbarn/Personal/Indicators/Tradovate/ Output path: Same directory as source file