javascript - Documenting external types with TypeDoc - Stack Overflow

admin管理员组

文章数量:1356378

I have two files, file A and file B. File A uses a class from file B. My goal is to reference the TypeDoc output for a class used in file B in the TypeDoc output for file A. I can't seem to do this.

I know you can reference a symbol contained in the same file with TypeDoc with double brackets, like [[Foo]], but this didn't work for an external type like this.

/** Trying to reference [[FileB.InnerClass]] like this doesn't work. */
// This here is what I want to include
export type InnerClass = FileB.InnerClass;

// More code...

Is this possible to achieve?

I have two files, file A and file B. File A uses a class from file B. My goal is to reference the TypeDoc output for a class used in file B in the TypeDoc output for file A. I can't seem to do this.

I know you can reference a symbol contained in the same file with TypeDoc with double brackets, like [[Foo]], but this didn't work for an external type like this.

/** Trying to reference [[FileB.InnerClass]] like this doesn't work. */
// This here is what I want to include
export type InnerClass = FileB.InnerClass;

// More code...

Is this possible to achieve?

• javascript
• typescript
• typedoc

Share Improve this question Follow edited Jul 26, 2019 at 21:25 Frank van Puffelen 600k8585 gold badges890890 silver badges860860 bronze badges asked Jul 25, 2019 at 23:40 Erik MacikErik Macik 18188 bronze badges

Add a ment  | 

1 Answer 1

Sorted by: Reset to default 11 +100

yes, it's possible.

1. correct the ment.
2. You don't have to enter the file name but you have to import object from file using import

import { InnerClass } from './FileB';

/**
 * See the [[InnerClass]] for more details.
 */
export type innerClass = InnerClass;

3. To generate docs, run the following mand.

when typedef it's global use this mand:

typedoc --out ./docs --target ES6 ./src/

or this when it's local:

npx typedoc --out ./docs --target ES6 ./src/

• ./docs is folder where generate documentation.

• ./src/ is folder where your code is.

• --target ES6 version of JavaScript.

If you want to show only classes without different modules, use this flag --mode file:

npx typedoc --out ./docs --mode file --target ES6 ./src/

for more info, see documentation.

本文标签： javascriptDocumenting external types with TypeDocStack Overflow