[wasm] add missing API xml doc#76196
Conversation
|
Note regarding the This serves as a reminder for when your PR is modifying a ref *.cs file and adding/modifying public APIs, to please make sure the API implementation in the src *.cs file is documented with triple slash comments, so the PR reviewers can sign off that change. |
|
@carlossanlop how do I run the completeness check on this ? |
The undoc APIs report is generated in dotnet-api-docs, not on runtime. So the only way to validate that this PR is complete, is by making sure the list of undoc APIs I provided in the issue is covered in this PR. Please help port the undoc APIs to dotnet-api-docs as well. That repo is the source of the intellisense package we ship to customers. We generate it there after the text goes through language review. |
|
@pavelsavara to port your triple slash comments to dotnet-api-docs, use the https://github.com/dotnet/api-docs-sync/ tool.
Assumptions of the example:
|
....InteropServices.JavaScript/src/System/Runtime/InteropServices/JavaScript/JSMarshalerType.cs
Outdated
Show resolved
Hide resolved
....InteropServices.JavaScript/src/System/Runtime/InteropServices/JavaScript/JSMarshalerType.cs
Outdated
Show resolved
Hide resolved
....InteropServices.JavaScript/src/System/Runtime/InteropServices/JavaScript/JSMarshalerType.cs
Outdated
Show resolved
Hide resolved
...Runtime.InteropServices.JavaScript/src/System/Runtime/InteropServices/JavaScript/JSObject.cs
Outdated
Show resolved
Hide resolved
...m.Runtime.InteropServices.JavaScript/src/System/Runtime/InteropServices/JavaScript/JSType.cs
Outdated
Show resolved
Hide resolved
...ipt/src/System/Runtime/InteropServices/JavaScript/Marshaling/JSMarshalerArgument.BigInt64.cs
Outdated
Show resolved
Hide resolved
...aScript/src/System/Runtime/InteropServices/JavaScript/Marshaling/JSMarshalerArgument.Func.cs
Outdated
Show resolved
Hide resolved
...aScript/src/System/Runtime/InteropServices/JavaScript/Marshaling/JSMarshalerArgument.Func.cs
Outdated
Show resolved
Hide resolved
carlossanlop
left a comment
There was a problem hiding this comment.
Left some suggestions for you to consider.
|
I created dotnet/dotnet-api-docs#8436 and generated the docs into via the tool. I didn't know how to create namespace doc in the runtime repo so I wrote it by hands in the |
Thanks. Yep, that was the right way to do it. It can't be ported. |
...nteropServices.JavaScript/src/System/Runtime/InteropServices/JavaScript/JSFunctionBinding.cs
Outdated
Show resolved
Hide resolved
...nteropServices.JavaScript/src/System/Runtime/InteropServices/JavaScript/JSFunctionBinding.cs
Outdated
Show resolved
Hide resolved
...nteropServices.JavaScript/src/System/Runtime/InteropServices/JavaScript/JSFunctionBinding.cs
Outdated
Show resolved
Hide resolved
...nteropServices.JavaScript/src/System/Runtime/InteropServices/JavaScript/JSFunctionBinding.cs
Outdated
Show resolved
Hide resolved
....InteropServices.JavaScript/src/System/Runtime/InteropServices/JavaScript/JSMarshalerType.cs
Outdated
Show resolved
Hide resolved
...m.Runtime.InteropServices.JavaScript/src/System/Runtime/InteropServices/JavaScript/JSHost.cs
Outdated
Show resolved
Hide resolved
....InteropServices.JavaScript/src/System/Runtime/InteropServices/JavaScript/JSMarshalerType.cs
Outdated
Show resolved
Hide resolved
....InteropServices.JavaScript/src/System/Runtime/InteropServices/JavaScript/JSMarshalerType.cs
Outdated
Show resolved
Hide resolved
...m.Runtime.InteropServices.JavaScript/src/System/Runtime/InteropServices/JavaScript/JSType.cs
Outdated
Show resolved
Hide resolved
...teropServices.JavaScript/src/System/Runtime/InteropServices/JavaScript/Legacy/ArrayBuffer.cs
Outdated
Show resolved
Hide resolved
Co-authored-by: Carlos Sanchez <[email protected]>
|
many thanks @carlossanlop |
|
Marked this as breaking since it removes an implicit public default constructor. cc @lewing |
Fixes #74734