cherry-pick(#33096): chore: various v1.48.0 roll fixes for .NET

microsoft · Oct 14, 2024 · e5bbd5e · e5bbd5e
1 parent daff1a9
commit e5bbd5e
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 12 deletions.
diff --git 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>|any]>
+- `handler` <[function]\([int]|[undefined], [string]|[undefined]\): [Promise<any>|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
@@ -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
@@ -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><description', _wrapAndEscape(node, maxColumns), summary, '/description></item');
     } else if (node.type === 'note') {
-      _wrapInNode('para', _wrapAndEscape(node, maxColumns), remarks);
+      _wrapInNode('para', _wrapAndEscape({
+        type: 'text',
+        text: render(node.children ?? []).replaceAll('\n', '↵'),
+      }, maxColumns), remarks);
     }
     lastNode = node;
   });
@@ -75,11 +78,11 @@ function _innerRenderNodes(nodes, maxColumns = 80, wrapParagraphs = true) {
 
 function _wrapCode(lines) {
   let i = 0;
-  let out = [];
+  const out = [];
   for (let line of lines) {
     line = line.replace(/[&]/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;');
     if (i < lines.length - 1)
-      line = line + "<br/>";
+      line = line + '<br/>';
     out.push(line);
     i++;
   }
@@ -163,4 +166,4 @@ function renderTextOnly(nodes, maxColumns = 80) {
   return result.summary;
 }
 
-module.exports = { renderXmlDoc, renderTextOnly }
+module.exports = { renderXmlDoc, renderTextOnly };
diff --git 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) {