Skip to content

Commit 260015d

Browse files
alalondeGerrit0
authored andcommitted
Added toc argument documentation
1 parent 09a37f2 commit 260015d

File tree

2 files changed

+3
-1
lines changed

2 files changed

+3
-1
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,8 @@ For a complete list of the command line arguments run `typedoc --help` or read [
100100
Specifies the fully qualified name of the root symbol. Defaults to global namespace.
101101
* `--gitRevision <revision|branch>`<br>
102102
Use specified revision or branch instead of the last revision for linking to GitHub source files.
103+
* `--toc EntryClass,ImportantInterface`<br>
104+
Define the contents of the top level table of contents as a comma-separated list of global symbols.
103105

104106
#### Content
105107
* `--includes <path/to/includes>`<br>

src/lib/output/renderer.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ export class Renderer extends ChildableComponent<Application, RendererComponent>
105105

106106
@Option({
107107
name: 'toc',
108-
help: 'Specifies the top level table of contents.',
108+
help: 'Define the contents of the top level table of contents as a comma-separated list of global symbols.',
109109
type: ParameterType.Array
110110
})
111111
toc!: string[];

0 commit comments

Comments
 (0)