- \`propWithFlag\` (*Experimental*)
+ \`propWithFlag\`
|
@@ -434,7 +357,9 @@ print("Hello, " + name + "!")
|
-‐
+**\`Experimental\`**
+
+Experimental flag comments
|
diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.class.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.class.spec.ts.snap
index 71f500c7..eddf980e 100644
--- a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.class.spec.ts.snap
+++ b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.class.spec.ts.snap
@@ -418,11 +418,11 @@ new ClassWithComplexProps(): ClassWithComplexProps
## Properties
-| Property | Type | Default value |
+| Property | Type | Description |
| :------ | :------ | :------ |
-| \`objecLiteralProp\` | \`object\` | \`...\` |
-| \`objecLiteralProp.someFunction\` | (\`a\`: \`string\`) => \`string\` | \`...\` |
-| \`objecLiteralProp.someProp\` | \`string\` | \`'someProp'\` |
+| \`objecLiteralProp\` | \`object\` | - |
+| \`objecLiteralProp.someFunction\` | (\`a\`: \`string\`) => \`string\` | Comments for someFunction |
+| \`objecLiteralProp.someProp\` | \`string\` | Comments for someProp |
"
`;
@@ -578,10 +578,10 @@ Comment for ClassWithFlags
### expermintalProp
-\`Experimental\`
-
> **expermintalProp**: \`string\`
+**\`Experimental\`**
+
#### Source
[classes.ts:1](http://source-url)
@@ -590,10 +590,10 @@ Comment for ClassWithFlags
### internalProp
-\`Internal\`
-
> \`private\` **internalProp**: \`string\`
+**\`Internal\`**
+
#### Source
[classes.ts:1](http://source-url)
@@ -602,10 +602,10 @@ Comment for ClassWithFlags
### expermintalMethod()
-\`Experimental\`
-
> **expermintalMethod**(): \`void\`
+**\`Experimental\`**
+
#### Returns
\`void\`
@@ -618,10 +618,10 @@ Comment for ClassWithFlags
### internalMethod()
-\`Internal\`
-
> \`protected\` **internalMethod**(): \`void\`
+**\`Internal\`**
+
#### Returns
\`void\`
@@ -651,21 +651,21 @@ new ClassWithFlags(): ClassWithFlags
## Properties
-| Property | Modifier | Type |
-| :------ | :------ | :------ |
-| \`expermintalProp\` (*Experimental*) | \`public\` | \`string\` |
-| \`internalProp\` (*Internal*) | \`private\` | \`string\` |
+| Property | Modifier | Type | Description |
+| :------ | :------ | :------ | :------ |
+| \`expermintalProp\` | \`public\` | \`string\` | **\`Experimental\`** |
+| \`internalProp\` | \`private\` | \`string\` | **\`Internal\`** |
## Methods
### expermintalMethod()
-\`Experimental\`
-
\`\`\`ts
expermintalMethod(): void
\`\`\`
+**\`Experimental\`**
+
#### Returns
\`void\`
@@ -678,12 +678,12 @@ expermintalMethod(): void
### internalMethod()
-\`Internal\`
-
\`\`\`ts
protected internalMethod(): void
\`\`\`
+**\`Internal\`**
+
#### Returns
\`void\`
diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.interface.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.interface.spec.ts.snap
index 837fe22f..a9ccd1cc 100644
--- a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.interface.spec.ts.snap
+++ b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.interface.spec.ts.snap
@@ -783,10 +783,10 @@ Comments for InterfaceWithFlags
### expermintalProp?
-\`Experimental\`
-
> \`optional\` **expermintalProp**: \`string\`
+**\`Experimental\`**
+
#### Source
[interfaces.ts:1](http://source-url)
@@ -795,10 +795,12 @@ Comments for InterfaceWithFlags
### internalProp
-\`Internal\`
-
> **internalProp**: \`string\`
+**\`Internal\`**
+
+Comments for internalProp
+
#### Source
[interfaces.ts:1](http://source-url)
@@ -812,10 +814,10 @@ Comments for InterfaceWithFlags
## Properties
-| Property | Type |
-| :------ | :------ |
-| \`expermintalProp?\` (*Experimental*) | \`string\` |
-| \`internalProp\` (*Internal*) | \`string\` |
+| Property | Type | Description |
+| :------ | :------ | :------ |
+| \`expermintalProp?\` | \`string\` | **\`Experimental\`** |
+| \`internalProp\` | \`string\` | **\`Internal\`** Comments for internalProp |
"
`;
diff --git a/typedoc.json b/typedoc.json
index 1dbc2404..aa11e82d 100644
--- a/typedoc.json
+++ b/typedoc.json
@@ -11,29 +11,12 @@
"./devtools/typedoc-plugins/typedoc-default-values.js",
"./packages/typedoc-plugin-remark/dist"
],
- "remarkPlugins": [
- [
- "remark-toc",
- {
- "tight": true,
- "maxDepth": 4,
- "skip": "Default Value|Defined in|Example|load|Parameters|Returns|See|Type declaration"
- }
- ]
- ],
"entryPointStrategy": "packages",
"outputFileStrategy": "members",
"membersWithOwnFile": ["Class", "Interface", "TypeAlias", "Enum"],
"readme": "none",
"mergeReadme": true,
"excludePrivate": false,
- "packageOptions": {
- "includeVersion": true,
- "excludePrivate": false,
- "readme": "./OVERVIEW.md",
- "sortEntryPoints": false,
- "sort": "source-order"
- },
"projectDocuments": ["./OVERVIEW.md"],
"hidePageHeader": true,
"hideGroupHeadings": true,
@@ -45,9 +28,20 @@
"parametersFormat": "table",
"enumMembersFormat": "table",
"typeDeclarationFormat": "table",
+ "interfacePropertiesFormat": "table",
"indexFormat": "table",
"tableColumnSettings": { "hideSources": true },
"sanitizeComments": true,
+ "remarkPlugins": [
+ [
+ "remark-toc",
+ {
+ "tight": true,
+ "maxDepth": 4,
+ "skip": "Default Value|Defined in|Example|load|Parameters|Returns|See|Type declaration"
+ }
+ ]
+ ],
"externalSymbolLinkMappings": {
"typedoc": {
"ArrayType": "https://typedoc.org/api/types/Models.ArrayType.html",
@@ -96,5 +90,12 @@
"UnionType": "https://typedoc.org/api/types/Models.UnionType.html",
"UrlMapping": "https://typedoc.org/api/classes/UrlMapping.html"
}
+ },
+ "packageOptions": {
+ "includeVersion": true,
+ "excludePrivate": false,
+ "readme": "./OVERVIEW.md",
+ "sortEntryPoints": false,
+ "sort": "source-order"
}
}