diff --git a/schemas/renderer/config.json b/schemas/renderer/config.json index 99319ee6..cf433615 100644 --- a/schemas/renderer/config.json +++ b/schemas/renderer/config.json @@ -115,12 +115,12 @@ }, "inlineTitleEncapsulation": { "anyOf": [ - { - "$ref": "#/definitions/Encapsulation" - }, { "const": false, "type": "boolean" + }, + { + "$ref": "#/definitions/Encapsulation" } ], "description": "Defines how inline titles should be encapsulated in the rendered output." @@ -136,33 +136,30 @@ }, "parameterEncapsulation": { "anyOf": [ - { - "$ref": "#/definitions/Encapsulation" - }, { "const": false, "type": "boolean" + }, + { + "$ref": "#/definitions/Encapsulation" } ], "description": "Defines how parameters should be encapsulated in the rendered output." }, "propertyEncapsulation": { "anyOf": [ - { - "$ref": "#/definitions/Encapsulation" - }, { "const": false, "type": "boolean" + }, + { + "$ref": "#/definitions/Encapsulation" } ], "description": "Defines how properties should be encapsulated in the rendered output." }, "renderClassMemberTitles": { "anyOf": [ - { - "type": "boolean" - }, { "const": "documentation", "type": "string" @@ -170,6 +167,9 @@ { "const": "tableOfContents", "type": "string" + }, + { + "type": "boolean" } ], "description": "Defines whether the renderer should render titles for object members." @@ -180,9 +180,6 @@ }, "renderEntityPrefixes": { "anyOf": [ - { - "type": "boolean" - }, { "const": "documentation", "type": "string" @@ -190,10 +187,17 @@ { "const": "tableOfContents", "type": "string" + }, + { + "type": "boolean" } ], "description": "Defines whether the renderer should render prefixes for entities." }, + "renderInternalEntities": { + "description": "Defines whether entities marked with an `@internal` tag should appear in the rendered output.", + "type": "boolean" + }, "renderOrder": { "description": "Defines the order in which entities should be rendered.", "items": { @@ -203,9 +207,6 @@ }, "renderParentNames": { "anyOf": [ - { - "type": "boolean" - }, { "const": "documentation", "type": "string" @@ -213,6 +214,9 @@ { "const": "tableOfContents", "type": "string" + }, + { + "type": "boolean" } ], "description": "Defines whether the parent name of members should be rendered in the signature." @@ -235,24 +239,24 @@ }, "stringLiteralEncapsulation": { "anyOf": [ - { - "$ref": "#/definitions/Encapsulation" - }, { "const": false, "type": "boolean" + }, + { + "$ref": "#/definitions/Encapsulation" } ], "description": "Defines how string literal type annotations should be encapsulated in the rendered output." }, "tagEncapsulation": { "anyOf": [ - { - "$ref": "#/definitions/Encapsulation" - }, { "const": false, "type": "boolean" + }, + { + "$ref": "#/definitions/Encapsulation" } ], "description": "Defines how tags like `@beta` or `@deprecated` should be encapsulated in the rendered output." @@ -492,24 +496,24 @@ }, "typeEncapsulation": { "anyOf": [ - { - "$ref": "#/definitions/Encapsulation" - }, { "const": false, "type": "boolean" + }, + { + "$ref": "#/definitions/Encapsulation" } ], "description": "Defines how type annotations should be encapsulated in the rendered output." }, "typeParameterEncapsulation": { "anyOf": [ - { - "$ref": "#/definitions/Encapsulation" - }, { "const": false, "type": "boolean" + }, + { + "$ref": "#/definitions/Encapsulation" } ], "description": "Defines how type parameters should be encapsulated in the rendered output." @@ -531,15 +535,15 @@ { "additionalProperties": { "anyOf": [ + { + "const": "*", + "type": "string" + }, { "items": { "type": "string" }, "type": "array" - }, - { - "const": "*", - "type": "string" } ] }, @@ -570,15 +574,15 @@ "properties": { "allowedHTMLTags": { "anyOf": [ + { + "const": false, + "type": "boolean" + }, { "items": { "type": "string" }, "type": "array" - }, - { - "const": false, - "type": "boolean" } ], "description": "Defines which HTML tags are allowed in the rendered output. Will be used in the future to render anchor nodes." @@ -589,12 +593,12 @@ }, "inlineTitleEncapsulation": { "anyOf": [ - { - "$ref": "#/definitions/Encapsulation" - }, { "const": false, "type": "boolean" + }, + { + "$ref": "#/definitions/Encapsulation" } ], "description": "Defines how inline titles should be encapsulated in the rendered output." @@ -610,33 +614,30 @@ }, "parameterEncapsulation": { "anyOf": [ - { - "$ref": "#/definitions/Encapsulation" - }, { "const": false, "type": "boolean" + }, + { + "$ref": "#/definitions/Encapsulation" } ], "description": "Defines how parameters should be encapsulated in the rendered output." }, "propertyEncapsulation": { "anyOf": [ - { - "$ref": "#/definitions/Encapsulation" - }, { "const": false, "type": "boolean" + }, + { + "$ref": "#/definitions/Encapsulation" } ], "description": "Defines how properties should be encapsulated in the rendered output." }, "renderClassMemberTitles": { "anyOf": [ - { - "type": "boolean" - }, { "const": "documentation", "type": "string" @@ -644,6 +645,9 @@ { "const": "tableOfContents", "type": "string" + }, + { + "type": "boolean" } ], "description": "Defines whether the renderer should render titles for object members." @@ -654,9 +658,6 @@ }, "renderEntityPrefixes": { "anyOf": [ - { - "type": "boolean" - }, { "const": "documentation", "type": "string" @@ -664,10 +665,17 @@ { "const": "tableOfContents", "type": "string" + }, + { + "type": "boolean" } ], "description": "Defines whether the renderer should render prefixes for entities." }, + "renderInternalEntities": { + "description": "Defines whether entities marked with an `@internal` tag should appear in the rendered output.", + "type": "boolean" + }, "renderOrder": { "description": "Defines the order in which entities should be rendered.", "items": { @@ -677,9 +685,6 @@ }, "renderParentNames": { "anyOf": [ - { - "type": "boolean" - }, { "const": "documentation", "type": "string" @@ -687,6 +692,9 @@ { "const": "tableOfContents", "type": "string" + }, + { + "type": "boolean" } ], "description": "Defines whether the parent name of members should be rendered in the signature." @@ -712,24 +720,24 @@ }, "stringLiteralEncapsulation": { "anyOf": [ - { - "$ref": "#/definitions/Encapsulation" - }, { "const": false, "type": "boolean" + }, + { + "$ref": "#/definitions/Encapsulation" } ], "description": "Defines how string literal type annotations should be encapsulated in the rendered output." }, "tagEncapsulation": { "anyOf": [ - { - "$ref": "#/definitions/Encapsulation" - }, { "const": false, "type": "boolean" + }, + { + "$ref": "#/definitions/Encapsulation" } ], "description": "Defines how tags like `@beta` or `@deprecated` should be encapsulated in the rendered output." @@ -969,24 +977,24 @@ }, "typeEncapsulation": { "anyOf": [ - { - "$ref": "#/definitions/Encapsulation" - }, { "const": false, "type": "boolean" + }, + { + "$ref": "#/definitions/Encapsulation" } ], "description": "Defines how type annotations should be encapsulated in the rendered output." }, "typeParameterEncapsulation": { "anyOf": [ - { - "$ref": "#/definitions/Encapsulation" - }, { "const": false, "type": "boolean" + }, + { + "$ref": "#/definitions/Encapsulation" } ], "description": "Defines how type parameters should be encapsulated in the rendered output."