Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion apps/api-documenter/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
},
"dependencies": {
"@microsoft/api-extractor-model": "workspace:*",
"@microsoft/tsdoc": "~0.16.0",
"@microsoft/tsdoc": "~0.17.0",
"@rushstack/node-core-library": "workspace:*",
"@rushstack/terminal": "workspace:*",
"@rushstack/ts-command-line": "workspace:*",
Expand Down
4 changes: 2 additions & 2 deletions apps/api-extractor/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,8 @@
},
"dependencies": {
"@microsoft/api-extractor-model": "workspace:*",
"@microsoft/tsdoc-config": "~0.18.1",
"@microsoft/tsdoc": "~0.16.0",
"@microsoft/tsdoc-config": "~0.18.2",
"@microsoft/tsdoc": "~0.17.0",
"@rushstack/node-core-library": "workspace:*",
"@rushstack/rig-package": "workspace:*",
"@rushstack/terminal": "workspace:*",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -542,7 +542,7 @@
{
"kind": "Class",
"canonicalReference": "api-documenter-scenarios!ExtendsClassFromAnotherPackage:class",
"docComment": "/**\n * Some class that extends a class from another package. This base class is not in any API doc model.\n *\n * @public\n */\n",
"docComment": "/**\n * Some class that extends a class from another package. This base class\n * is not in any API doc model.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
Expand Down Expand Up @@ -635,7 +635,7 @@
{
"kind": "Interface",
"canonicalReference": "api-documenter-scenarios!IExtendsInterfaceLikeTypeAlias:interface",
"docComment": "/**\n * Some interface that extends an interface-like type alias as well as another interface.\n *\n * @public\n */\n",
"docComment": "/**\n * Some interface that extends an interface-like type alias as well as\n * another interface.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@
},
"kind": "Package",
"canonicalReference": "api-documenter-test!",
"docComment": "/**\n * api-extractor-test-05\n *\n * This project tests various documentation generation scenarios and doc comment syntaxes.\n *\n * @packageDocumentation\n */\n",
"docComment": "/**\n * api-extractor-test-05\n *\n * This project tests various documentation generation scenarios and\n * doc comment syntaxes.\n *\n * @packageDocumentation\n */\n",
"name": "api-documenter-test",
"preserveMemberOrder": false,
"members": [
Expand Down Expand Up @@ -528,7 +528,7 @@
{
"kind": "Method",
"canonicalReference": "api-documenter-test!DocClass1#exampleFunction:member(1)",
"docComment": "/**\n * This is an overloaded function.\n *\n * @param a - the first string\n *\n * @param b - the second string\n *\n * @throws\n *\n * `Error` The first throws line\n *\n * @throws\n *\n * The second throws line\n */\n",
"docComment": "/**\n * This is an overloaded function.\n *\n * @param a - the first string\n *\n * @param b - the second string\n *\n * @throws\n *\n * `Error`\n * The first throws line\n *\n * @throws\n *\n * The second throws line\n */\n",
"excerptTokens": [
{
"kind": "Content",
Expand Down Expand Up @@ -1045,7 +1045,7 @@
{
"kind": "Method",
"canonicalReference": "api-documenter-test!DocClass1#tableExample:member(1)",
"docComment": "/**\n * An example with tables:\n *\n * @remarks\n *\n * <table> <tr> <td>John</td> <td>Doe</td> </tr> </table>\n */\n",
"docComment": "/**\n * An example with tables:\n *\n * @remarks\n *\n * <table>\n * <tr>\n * <td>John</td>\n * <td>Doe</td>\n * </tr></table>\n */\n",
"excerptTokens": [
{
"kind": "Content",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -454,7 +454,7 @@ methods:
package: api-documenter-test!
fullName: tableExample()
summary: 'An example with tables:'
remarks: <table> <tr> <td>John</td> <td>Doe</td> </tr> </table>
remarks: <table> <tr> <td>John</td> <td>Doe</td> </tr></table>
example: []
isPreview: false
isDeprecated: false
Expand Down Expand Up @@ -1743,7 +1743,7 @@ string

## Exceptions

\`Error\` The first throws line
\`Error\` The first throws line

The second throws line

Expand Down Expand Up @@ -2504,7 +2504,7 @@ void

## Remarks

<table> <tr> <td>John</td> <td>Doe</td> </tr> </table>
<table> <tr> <td>John</td> <td>Doe</td> </tr></table>

",
"/api-documenter-test.docclass1.writeableproperty.md": "<!-- Do not edit this file. It is automatically generated by API Documenter. -->
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -330,7 +330,7 @@
{
"kind": "Function",
"canonicalReference": "api-extractor-scenarios!succeedWithExternalReference:function(1)",
"docComment": "/**\n * NOTE: The broken link checker currently is not able to validate references to external packages. Tracked by: https://github.com/microsoft/rushstack/issues/1195 {@link nonexistent#nonexistent}\n *\n * @public\n */\n",
"docComment": "/**\n * NOTE: The broken link checker currently is not able to validate references to external packages.\n * Tracked by: https://github.com/microsoft/rushstack/issues/1195{@link nonexistent#nonexistent}\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
Expand Down Expand Up @@ -358,7 +358,7 @@
{
"kind": "Function",
"canonicalReference": "api-extractor-scenarios!succeedWithSelector:function(1)",
"docComment": "/**\n * {@link (A:namespace).B.myMethod | the method} {@link (A:interface).myProperty | the property}\n *\n * @public\n */\n",
"docComment": "/**\n * {@link (A:namespace).B.myMethod | the method}{@link (A:interface).myProperty | the property}\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@
{
"kind": "Class",
"canonicalReference": "api-extractor-scenarios!~AnotherDuplicateName:class",
"docComment": "/**\n * This forgotten item has the same name as another forgotten item in another file. They should be given unique names.\n *\n * @public\n */\n",
"docComment": "/**\n * This forgotten item has the same name as another forgotten item in another\n * file. They should be given unique names.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
Expand All @@ -227,7 +227,7 @@
{
"kind": "TypeAlias",
"canonicalReference": "api-extractor-scenarios!~DuplicateName_2:type",
"docComment": "/**\n * Will be renamed to avoid a name conflict with the exported `DuplicateName` from index.ts.\n *\n * @public\n */\n",
"docComment": "/**\n * Will be renamed to avoid a name conflict with the exported `DuplicateName` from\n * index.ts.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
Expand All @@ -253,7 +253,7 @@
{
"kind": "TypeAlias",
"canonicalReference": "api-extractor-scenarios!DuplicateName:type",
"docComment": "/**\n * This type is exported but has the same name as a forgotten type in './internal.ts'. This forgotten type is also included in the API report and doc model files. The forgotten type will be renamed to avoid a name conflict.\n *\n * @public\n */\n",
"docComment": "/**\n * This type is exported but has the same name as a forgotten type in './internal.ts'. This\n * forgotten type is also included in the API report and doc model files. The forgotten type\n * will be renamed to avoid a name conflict.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
Expand All @@ -279,7 +279,7 @@
{
"kind": "Class",
"canonicalReference": "api-extractor-scenarios!~ForgottenExport1:class",
"docComment": "/**\n * `ForgottenExport2` wants to inherit this doc comment, but unfortunately this isn't supported yet\n *\n * @public\n */\n",
"docComment": "/**\n * `ForgottenExport2` wants to inherit this doc comment, but unfortunately this isn't\n * supported yet\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@
{
"kind": "Function",
"canonicalReference": "api-extractor-scenarios!alphaFunctionReturnsBeta:function(1)",
"docComment": "/**\n * It's okay for an \"alpha\" function to reference a \"beta\" symbol, because \"beta\" is more public than \"alpha\".\n *\n * @alpha\n */\n",
"docComment": "/**\n * It's okay for an \"alpha\" function to reference a \"beta\" symbol,\n * because \"beta\" is more public than \"alpha\".\n *\n * @alpha\n */\n",
"excerptTokens": [
{
"kind": "Content",
Expand Down Expand Up @@ -265,7 +265,7 @@
{
"kind": "Function",
"canonicalReference": "api-extractor-scenarios!publicFunctionReturnsBeta:function(1)",
"docComment": "/**\n * It's not okay for a \"public\" function to reference a \"beta\" symbol, because \"beta\" is less public than \"public\".\n *\n * @public\n */\n",
"docComment": "/**\n * It's not okay for a \"public\" function to reference a \"beta\" symbol,\n * because \"beta\" is less public than \"public\".\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -359,7 +359,7 @@
{
"kind": "Method",
"canonicalReference": "api-extractor-scenarios!ExampleC#member1:member(1)",
"docComment": "/**\n * This comment is improperly formatted TSDoc. Note that Prettier doesn't try to format it.\n *\n * @returns the return value\n *\n * @throws\n *\n * an exception\n */\n",
"docComment": "/**\n * This comment is improperly formatted TSDoc.\n * Note that Prettier doesn't try to format it.\n *\n * @returns the return value\n *\n * @throws\n *\n * an exception\n */\n",
"excerptTokens": [
{
"kind": "Content",
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"changes": [
{
"packageName": "@microsoft/api-documenter",
"comment": "Update the `@microsoft/tsdoc` dependency to `~0.17.0`.",
"type": "patch"
}
],
"packageName": "@microsoft/api-documenter"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"changes": [
{
"packageName": "@microsoft/api-extractor-model",
"comment": "Update the `@microsoft/tsdoc` dependency to `~0.17.0` and the `@microsoft/tsdoc-config` dependency to `~0.18.2`.",
"type": "patch"
}
],
"packageName": "@microsoft/api-extractor-model"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"changes": [
{
"packageName": "@microsoft/api-extractor",
"comment": "Update the `@microsoft/tsdoc` dependency to `~0.17.0` and the `@microsoft/tsdoc-config` dependency to `~0.18.2`.",
"type": "patch"
}
],
"packageName": "@microsoft/api-extractor"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"changes": [
{
"packageName": "@rushstack/eslint-config",
"comment": "Update the `eslint-plugin-tsdoc` dependency to `~0.5.3`.",
"type": "patch"
}
],
"packageName": "@rushstack/eslint-config"
}
11 changes: 0 additions & 11 deletions common/config/rush/pnpm-config.json
Original file line number Diff line number Diff line change
Expand Up @@ -476,17 +476,6 @@
}
},

"eslint-plugin-tsdoc": {
"peerDependenciesMeta": {
"eslint": {
"optional": true
}
},
"peerDependencies": {
"eslint": "*"
}
},

"query-ast": {
"dependencies": {
"lodash": "~4.17.15"
Expand Down
46 changes: 23 additions & 23 deletions common/config/subspaces/build-tests-subspace/pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// DO NOT MODIFY THIS FILE MANUALLY BUT DO COMMIT IT. It is generated and used by Rush.
{
"pnpmShrinkwrapHash": "a75f2d587da6f34c43fb87a43a14e3d4632cfe49",
"pnpmShrinkwrapHash": "0a8c0de71e3099a9953da0655c771cff69040acf",
"preferredVersionsHash": "550b4cee0bef4e97db6c6aad726df5149d20e7d9",
"packageJsonInjectedDependenciesHash": "7a9032ff2ab4a81098c7080334d0c42a1e2b1798"
"packageJsonInjectedDependenciesHash": "2b369e7b05e31f15c36822555610ed5d1b092b8b"
}
Loading