System.Text.Json - Undoc 6.0 APIs

[carlossanlop]

Updated list:

The following APIs were introduced in 6.0 and did not get documented in triple slash. They will need to be manually documented directly in dotnet-api-docs, and must target the net6-rc1 branch. This needs to be done before Tuesday September 14th so we have enough time to generate the IntelliSense package that will be shipped to GA.

Update: see table in my comment below: #54862 (comment)

Tagging subscribers to this area: @eiriktsarpalis, @layomia
See info in area-owners.md if you want to be subscribed.

Issue Details

---

The APIs in the table below were introduced in .NET 6.0 and are showing up as undocumented in the dotnet-api-docs repo.

Some of them are already documented in triple slash comments in source. Area owners, please:

1. Verify if there are any APIs from the table have not been documented in source. If you find any, document them in triple slash and submit a PR to runtime to commit the documentation.
2. Clone the dotnet-api-docs repo and port the triple slash comments by running this DocsPortingTool command:

DocsPortingTool \
    -Direction ToDocs \
    -Docs %REPOS%\dotnet-api-docs\xml \
    -Intellisense %REPOS%\runtime\artifacts\bin\ \
    -IncludedAssemblies System.Text.Json \
    -IncludedNamespaces System.Text.Json \
    -Save true

3. Submit a PR to dotnet-api-docs with the ported documentation.

Undoc 6.0 System.Text.Json APIs table

Undoc 6.0 API
M:System.Text.Json.JsonElement.ParseValue(System.Text.Json.Utf8JsonReader@)
M:System.Text.Json.JsonElement.TryParseValue(System.Text.Json.Utf8JsonReader@,System.Nullable{System.Text.Json.JsonElement}@)
M:System.Text.Json.JsonSerializer.Deserialize(System.ReadOnlySpan{System.Char},System.Type,System.Text.Json.JsonSerializerOptions)
M:System.Text.Json.JsonSerializer.Deserialize``1(System.ReadOnlySpan{System.Char},System.Text.Json.JsonSerializerOptions)
P:System.Text.Json.Serialization.ReferenceHandler.IgnoreCycles

Author:	carlossanlop
Assignees:	-
Labels:	area-System.Text.Json, untriaged
Milestone:	6.0.0

[eiriktsarpalis]

Given that we are still working on adding new APIs, this issue should be addressed after STJ is feature complete for 6.0

[eiriktsarpalis]

#57302 is adding new APIs to System.Text.Json, likely the final set of changes for 6.0