File tree Expand file tree Collapse file tree 5 files changed +11
-16
lines changed
Expand file tree Collapse file tree 5 files changed +11
-16
lines changed Original file line number Diff line number Diff line change @@ -33,9 +33,6 @@ const config = {
3333 } ,
3434 ] ,
3535
36- // This can probably be turned back on in 0.27, when the component hierarchy goes away
37- // "@typescript-eslint/no-unsafe-function-type": "off", GERRIT
38-
3936 // This one is just annoying since it complains at incomplete code
4037 "no-empty" : "off" ,
4138
Original file line number Diff line number Diff line change @@ -322,12 +322,3 @@ typedoc --readme <path/to/readme|none>
322322Path to the readme file that should be displayed on the index page. If set to
323323` none ` , or no readme file is automatically discovered, the index page will be
324324disabled.
325-
326- ## includeHierarchySummary
327-
328- ``` bash
329- typedoc --includeHierarchySummary false
330- ```
331-
332- Specifies whether or not to generate the ` hierarchy.html ` page in the output
333- which lists the full class hierarchy for generated members. Defaults to ` true ` .
Original file line number Diff line number Diff line change @@ -656,3 +656,12 @@ page for each member which is rendered on another page. If the
656656[ ` @summary ` ] ( ../tags/summary.md ) tag is used, it will specify the short summary
657657text. If ` @summary ` is not used, this option controls whether TypeDoc will use
658658the first paragraph from the comment as the short summary or leave it blank.
659+
660+ ## includeHierarchySummary
661+
662+ ``` bash
663+ typedoc --includeHierarchySummary false
664+ ```
665+
666+ Specifies whether or not to generate the ` hierarchy.html ` page in the output
667+ which lists the full class hierarchy for generated members. Defaults to ` true ` .
Original file line number Diff line number Diff line change @@ -53,7 +53,6 @@ at the root level. The following tables indicate where an option should be set.
5353| [ ` gitRemote ` ] ( input.md#gitremote ) | Package | |
5454| [ ` disableGit ` ] ( input.md#disablegit ) | Package | |
5555| [ ` readme ` ] ( input.md#readme ) | Both | Root: Site readme, Package: Package readme |
56- | [ ` includeHierarchySummary ` ] ( input.md#includehierarchysummary ) | Root | |
5756
5857## Output Options
5958
@@ -104,6 +103,7 @@ at the root level. The following tables indicate where an option should be set.
104103| [ ` hostedBaseUrl ` ] ( output.md#hostedbaseurl ) | Root | |
105104| [ ` useHostedBaseUrlForAbsoluteLinks ` ] ( output.md#usehostedbaseurlforabsolutelinks ) | Root | |
106105| [ ` useFirstParagraphOfCommentAsSummary ` ] ( output.md#usefirstparagraphofcommentassummary ) | Root | |
106+ | [ ` includeHierarchySummary ` ] ( input.md#includehierarchysummary ) | Root | |
107107
108108## Comment Options
109109
Original file line number Diff line number Diff line change @@ -51,14 +51,12 @@ export const rootPackageOptions = [
5151 "plugin" ,
5252 // Input Options
5353 "packageOptions" ,
54- "includeHierarchySummary" , // GERRIT: Move to output options
5554 // Output Options
5655 "outputs" ,
5756 "out" ,
5857 "html" ,
5958 "json" ,
6059 "pretty" ,
61- // emit
6260 "theme" ,
6361 "router" ,
6462 "lightHighlightTheme" ,
@@ -72,7 +70,6 @@ export const rootPackageOptions = [
7270 "customFooterHtmlDisableWrapper" ,
7371 "markdownItOptions" ,
7472 "markdownItLoader" ,
75- // basePath
7673 "cname" ,
7774 "favicon" ,
7875 "sourceLinkExternal" ,
@@ -98,6 +95,7 @@ export const rootPackageOptions = [
9895 "hostedBaseUrl" ,
9996 "useHostedBaseUrlForAbsoluteLinks" ,
10097 "useFirstParagraphOfCommentAsSummary" ,
98+ "includeHierarchySummary" ,
10199 // Comment Options
102100 "notRenderedTags" ,
103101 // Organization Options
You can’t perform that action at this time.
0 commit comments