Added toc argument documentation

TypeStrong · Oct 10, 2019 · e0b1c35 · e0b1c35
1 parent fd4f66f
commit e0b1c35
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -100,6 +100,8 @@ For a complete list of the command line arguments run `typedoc --help` or read [
   Specifies the fully qualified name of the root symbol. Defaults to global namespace.
 * `--gitRevision <revision|branch>`<br>
   Use specified revision or branch instead of the last revision for linking to GitHub source files.
+* `--toc EntryClass,ImportantInterface`<br>
+  Define the contents of the top level table of contents as a comma-separated list of global symbols.
 
 #### Content
 * `--includes <path/to/includes>`<br>

diff --git a/src/lib/output/renderer.ts b/src/lib/output/renderer.ts
@@ -105,7 +105,7 @@ export class Renderer extends ChildableComponent<Application, RendererComponent>
 
     @Option({
         name: 'toc',
-        help: 'Specifies the top level table of contents.',
+        help: 'Define the contents of the top level table of contents as a comma-separated list of global symbols.',
         type: ParameterType.Array
     })
     toc!: string[];