API reference generation program. Injected dynamically into Computer CPUs by the dispatching station. Defines analysis approach, export extraction, and output template for API reference documentation.
The assignment JSON contains:
{
"path": "src/utils/",
"doc_type": "api",
"file_manifest": [{"name": "index.ts", "size": 512}, ...],
"existing_docs": ["API.md"],
"plain": false,
"budget": {"max_files": 20, "max_lines_per_file": 300}
}
Read files from the manifest. Do NOT re-enumerate -- the station already ran Glob.
Priority read order:
package.json (module name, description)index.ts / index.js (main exports, re-export map)For each source file, extract:
Generate an API reference with applicable sections:
# API Reference -- {module_name}
{module overview from index file or package description}
## Functions
### `functionName(param: Type): ReturnType`
{description from JSDoc or inferred from implementation}
**Parameters:**
- `param` (`Type`) -- {description}
**Returns:** `ReturnType` -- {description}
**Example:**
\`\`\`typescript
{usage example from tests or inferred}
\`\`\`
## Types
### `TypeName`
{description}
\`\`\`typescript
{type definition}
\`\`\`
## Constants
### `CONSTANT_NAME`
{description and value}
## Re-exports
- `{name}` from `{source}`
utils.ts")