From e5bbd5effe7383c9398d9e082627d4d0cf728592 Mon Sep 17 00:00:00 2001 From: Max Schmitt Date: Mon, 14 Oct 2024 16:32:11 +0200 Subject: [PATCH] cherry-pick(#33096): chore: various v1.48.0 roll fixes for .NET --- docs/src/api/class-websocketroute.md | 14 ++++++++++---- docs/src/api/params.md | 2 +- utils/doclint/dotnetXmlDocumentation.js | 13 ++++++++----- utils/doclint/generateDotnetApi.js | 5 +++-- 4 files changed, 22 insertions(+), 12 deletions(-) diff --git a/docs/src/api/class-websocketroute.md b/docs/src/api/class-websocketroute.md index e5347b07b1448..f977050481120 100644 --- a/docs/src/api/class-websocketroute.md +++ b/docs/src/api/class-websocketroute.md @@ -256,19 +256,25 @@ By default, closing one side of the connection, either in the page or on the ser ### param: WebSocketRoute.onClose.handler * since: v1.48 * langs: js, python -- `handler` <[function]\([number]|[undefined], [string]|[undefined]\): [Promise|any]> +- `handler` <[function]\([int]|[undefined], [string]|[undefined]\): [Promise|any]> Function that will handle WebSocket closure. Received an optional [close code](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/close#code) and an optional [close reason](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/close#reason). ### param: WebSocketRoute.onClose.handler * since: v1.48 -* langs: java, csharp -- `handler` <[function]\([null]|[number], [null]|[string]\)> +* langs: java +- `handler` <[function]\([null]|[int], [null]|[string]\)> Function that will handle WebSocket closure. Received an optional [close code](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/close#code) and an optional [close reason](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/close#reason). +### param: WebSocketRoute.onClose.handler +* since: v1.48 +* langs: csharp +- `handler` <[function]\([int?], [string]\)> + +Function that will handle WebSocket closure. Received an optional [close code](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/close#code) and an optional [close reason](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/close#reason). -## async method: WebSocketRoute.onMessage +## method: WebSocketRoute.onMessage * since: v1.48 This method allows to handle messages that are sent by the WebSocket, either from the page or from the server. diff --git a/docs/src/api/params.md b/docs/src/api/params.md index 1f9c03d77af35..e86c0a19f459e 100644 --- a/docs/src/api/params.md +++ b/docs/src/api/params.md @@ -363,7 +363,7 @@ Target URL. ## js-fetch-option-params * langs: js -- `params` <[Object]<[string], [string]|[number]|[boolean]>|[URLSearchParams]|[string]> +- `params` <[Object]<[string], [string]|[float]|[boolean]>|[URLSearchParams]|[string]> Query parameters to be sent with the URL. diff --git a/utils/doclint/dotnetXmlDocumentation.js b/utils/doclint/dotnetXmlDocumentation.js index 66fae02c12977..4b500c0781581 100644 --- a/utils/doclint/dotnetXmlDocumentation.js +++ b/utils/doclint/dotnetXmlDocumentation.js @@ -16,7 +16,7 @@ // @ts-check const Documentation = require('./documentation'); -const { visitAll } = require('../markdown'); +const { visitAll, render } = require('../markdown'); /** * @param {Documentation.MarkdownNode[]} nodes * @param {number} maxColumns @@ -64,7 +64,10 @@ function _innerRenderNodes(nodes, maxColumns = 80, wrapParagraphs = true) { } else if (node.type === 'li') { _wrapInNode('item>/g, '>'); if (i < lines.length - 1) - line = line + "
"; + line = line + '
'; out.push(line); i++; } @@ -163,4 +166,4 @@ function renderTextOnly(nodes, maxColumns = 80) { return result.summary; } -module.exports = { renderXmlDoc, renderTextOnly } \ No newline at end of file +module.exports = { renderXmlDoc, renderTextOnly }; \ No newline at end of file diff --git a/utils/doclint/generateDotnetApi.js b/utils/doclint/generateDotnetApi.js index 006d6e494c6d2..2e82f92d0ad3a 100644 --- a/utils/doclint/generateDotnetApi.js +++ b/utils/doclint/generateDotnetApi.js @@ -520,7 +520,8 @@ function renderMethod(member, parent, name, options, out) { && !name.startsWith('Get') && name !== 'CreateFormData' && !name.startsWith('PostDataJSON') - && !name.startsWith('As')) { + && !name.startsWith('As') + && name !== 'ConnectToServer') { if (!member.async) { if (member.spec && !options.nodocs) out.push(...XmlDoc.renderXmlDoc(member.spec, maxDocumentationColumnWidth)); @@ -718,7 +719,7 @@ function translateType(type, parent, generateNameCallback = t => t.name, optiona if (type.expression === '[null]|[Error]') return 'void'; - if (type.name == 'Promise' && type.templates?.[0].name === 'any') + if (type.name === 'Promise' && type.templates?.[0].name === 'any') return 'Task'; if (type.union) {