node.js - Ako písať dokumentáciu pre nezávislé pomocné funkcie/scenáre a mať ich zobrazené v ./docs/modules.html?


Učím sa používať TypeDoc (verzia 0.22.12) na písanie dokumentácie v mojom projekte typescript/node.js.

Môj projekt som zorganizoval tak, že mám priečinok utilities s jedným súborom .ts na jednu užitočnú funkciu.

.
│   package.json
│   tsconfig.json
│
└───src
    │   index.ts
    │
    └───utils
            addNumbers.ts
            subNumbers.ts

Obsah addNumbers.ts, napríklad:

// addNumbers.ts
export function addNumbers(a: number, b: number): number { 
    return a + b; 
} 

Rovnako, subNumbers.ts:

// subNumbers.ts
export function subNumbers(a: number, b: number): number { 
    return a - b; 
} 

Chcem dokumentovať každú funkciu, napríklad pomocou @param a @returns od TypeDoc.

Tak píšem:

// addNumbers.ts
/**
 * Function to add two numbers
 * @param a the first number
 * @param b the second number
 * @returns number equal to the addition of a and b
 */
export function addNumbers(a: number, b: number): number { 
    return a + b; 
}

Potom, keď vykonám

npx typedoc --out docs

Chápem

Info: Dokumentácia vygenerovaná v ./docs

Takže idem do ./docs/modules.html, kliknem pravým tlačidlom a potom otvoriť pomocou live servera (VSCode), a dostanem webovú stránku s ničím v sekcii Exports.

Čo robím zle?


Možno stojí za zmienku, že som do súboru tsconfig.json pridal nasledovné:

"typedocOptions": {
  "entryPoints": ["src/index.ts"],
  "out": "docs"
}

Nie som si istý, či problém spočíva v tom tsconfig.json.