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?
TypeDoc converts comments in TypeScript source code into rendered HTML documentation or a JSON model. It is extensible and supports a variety of configurations. Available as a CLI or Node module.
What is TSDoc? TSDoc is a proposal to standardize the doc comments used in TypeScript code, so that different tools can extract content without getting confused by each other's markup. The TSDoc notation looks pretty familiar: export class Statistics { /** * Returns the average of two numbers.
By saving TypeDoc to the project package. json file with the previous command, anyone who runs npm install on the project will have typedoc installed at the specific version required for the project.
yes, it's possible.
import
import { InnerClass } from './FileB';
/**
* See the [[InnerClass]] for more details.
*/
export type innerClass = InnerClass;
when typedef
it's global use this command:
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.
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With