Skip to content

System.Text.Json - Undoc 6.0 APIs #54862

Closed
Closed
System.Text.Json - Undoc 6.0 APIs#54862
Assignees
eiriktsarpalissteveharterlayomia
Labels
area-System.Text.JsondocumentationDocumentation bug or enhancement, does not impact product or test code
Milestone
6.0.0

Description

@carlossanlop
carlossanlop
opened on Jun 28, 2021

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)

Activity

  1. carlossanlop
    added this to the 6.0.0 milestone on Jun 28, 2021
  2. ghost added
    area-System.Text.Json
    on Jun 28, 2021
  3. ghost added
    untriagedNew issue has not been triaged by the area owner
    on Jun 28, 2021
  5. eiriktsarpalis
    added
    documentationDocumentation bug or enhancement, does not impact product or test code
    and removed
    untriagedNew issue has not been triaged by the area owner
    on Jun 29, 2021

  6. eiriktsarpalis commented on Jun 29, 2021

    @eiriktsarpalis
    eiriktsarpalis
    on Jun 29, 2021
    Member

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

  7. eiriktsarpalis
    self-assigned this
    on Aug 4, 2021
  8. danmoseley
    added
    zbb-exception
    on Aug 13, 2021

  9. eiriktsarpalis commented on Aug 16, 2021

    @eiriktsarpalis
    eiriktsarpalis
    on Aug 16, 2021
    Member

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

  10. danmoseley
    removed
    zbb-exception
    on Aug 23, 2021
  11. carlossanlop
    assigned
    eiriktsarpalis
    ,
    layomia
    and
    steveharter
    and unassigned
    eiriktsarpalis
    on Sep 3, 2021

  12. carlossanlop commented on Sep 3, 2021

    @carlossanlop
    carlossanlop
    on Sep 3, 2021
    ContributorAuthor

    I ported all the documentation that existed in triple slash: dotnet/dotnet-api-docs#7094

    I updated the list of undoc APIs that have yet to be documented. See the issue description.

  13. eiriktsarpalis commented on Sep 6, 2021

    @eiriktsarpalis
    eiriktsarpalis
    on Sep 6, 2021
    Member

    @steveharter @layomia could you take a look? We're missing a few doc elements from triple slash documentation. On quick inspection these seem to be minor things such as missing <returns/> or ` elements but these should be added for 6.0.0.

    These can be identified by looking for the To be added. placeholder in the linked xml docs. Note that some of these will be fixed by #7094 so I would recommend holding off until that PR is merged.

  14. eerhardt commented on Sep 7, 2021

    @eerhardt
    eerhardt
    on Sep 7, 2021
    Member

    N:System.Text.Json.SourceGeneration

    Nothing in the "SourceGeneration" namespace is public API that consumers should be using. @carlossanlop - is there a way we can remove any members coming from the https://github.com/dotnet/runtime/blob/main/src/libraries/System.Text.Json/gen/System.Text.Json.SourceGeneration.csproj library? We shouldn't have them on docs.microsoft.com.

  15. carlossanlop commented on Sep 9, 2021

    @carlossanlop
    carlossanlop
    on Sep 9, 2021
    ContributorAuthor

    @eerhardt thanks for letting me know. I'll remove those APIs from the undoc debt. I opened a bug for the Docs dev team to address it.

  16. carlossanlop commented on Sep 9, 2021

    @carlossanlop
    carlossanlop
    on Sep 9, 2021
    ContributorAuthor

    I generated a Docs Excel report last night. So if I exclude SourceGeneration, this is the list of APIs that need some documentation. The most important ones are those with a missing summary. They should all have that item filled out at the very least:

    Summary Parameters TypeParameters ReturnValue Undoc APIs
    Missing Missing NA NA M:System.Text.Json.Nodes.JsonArray.WriteTo(System.Text.Json.Utf8JsonWriter,System.Text.Json.JsonSerializerOptions)
    Missing Missing NA NA M:System.Text.Json.Nodes.JsonObject.WriteTo(System.Text.Json.Utf8JsonWriter,System.Text.Json.JsonSerializerOptions)
    Missing NA NA NA N:System.Text.Json.Nodes
    Missing NA NA NA M:System.Text.Json.Serialization.JsonSourceGenerationOptionsAttribute.#ctor
    Missing NA NA NA M:System.Text.Json.Serialization.Metadata.JsonObjectInfoValues`1.#ctor
    Missing NA NA NA M:System.Text.Json.Serialization.Metadata.JsonParameterInfoValues.#ctor
    Missing NA NA NA N:System.Text.Json.Serialization.Metadata
    Present Present Missing Present M:System.Text.Json.JsonSerializer.Deserialize``1(System.Text.Json.Nodes.JsonNode,System.Text.Json.Serialization.Metadata.JsonTypeInfo{``0})
    Present Present Missing Present M:System.Text.Json.JsonSerializer.Deserialize``1(System.Text.Json.JsonDocument,System.Text.Json.Serialization.Metadata.JsonTypeInfo{``0})
    Present Present Missing Present M:System.Text.Json.JsonSerializer.Deserialize``1(System.Text.Json.Utf8JsonReader@,System.Text.Json.Serialization.Metadata.JsonTypeInfo{``0})
    Present Present Missing Present M:System.Text.Json.JsonSerializer.Deserialize``1(System.ReadOnlySpan{System.Char},System.Text.Json.Serialization.Metadata.JsonTypeInfo{``0})
    Present Present Missing Present M:System.Text.Json.JsonSerializer.Deserialize``1(System.Text.Json.JsonElement,System.Text.Json.JsonSerializerOptions)
    Present Present Missing Present M:System.Text.Json.JsonSerializer.Deserialize``1(System.Text.Json.JsonDocument,System.Text.Json.JsonSerializerOptions)
    Present Present Missing Present M:System.Text.Json.JsonSerializer.Deserialize``1(System.IO.Stream,System.Text.Json.Serialization.Metadata.JsonTypeInfo{``0})
    Present Present Missing Present M:System.Text.Json.JsonSerializer.Deserialize``1(System.ReadOnlySpan{System.Char},System.Text.Json.JsonSerializerOptions)
    Present Present Missing Present M:System.Text.Json.JsonSerializer.Deserialize``1(System.ReadOnlySpan{System.Byte},System.Text.Json.Serialization.Metadata.JsonTypeInfo{``0})
    Present Present Missing Present M:System.Text.Json.JsonSerializer.Deserialize``1(System.IO.Stream,System.Text.Json.JsonSerializerOptions)
    Present Present Missing Present M:System.Text.Json.JsonSerializer.Deserialize``1(System.String,System.Text.Json.Serialization.Metadata.JsonTypeInfo{``0})
    Present Present Missing Present M:System.Text.Json.JsonSerializer.Deserialize``1(System.Text.Json.JsonElement,System.Text.Json.Serialization.Metadata.JsonTypeInfo{``0})
    Present Present Missing Present M:System.Text.Json.JsonSerializer.Deserialize``1(System.Text.Json.Nodes.JsonNode,System.Text.Json.JsonSerializerOptions)
    Present Present Missing Present M:System.Text.Json.JsonSerializer.DeserializeAsync``1(System.IO.Stream,System.Text.Json.Serialization.Metadata.JsonTypeInfo{``0},System.Threading.CancellationToken)
    Present Present Missing Present M:System.Text.Json.JsonSerializer.DeserializeAsyncEnumerable``1(System.IO.Stream,System.Text.Json.JsonSerializerOptions,System.Threading.CancellationToken)
    Present Missing NA NA M:System.Text.Json.JsonSerializer.Serialize(System.Text.Json.Utf8JsonWriter,System.Object,System.Type,System.Text.Json.Serialization.JsonSerializerContext)
    Present Present Missing Present M:System.Text.Json.JsonSerializer.Serialize``1(``0,System.Text.Json.Serialization.Metadata.JsonTypeInfo{``0})
    Present Present Missing NA M:System.Text.Json.JsonSerializer.Serialize``1(System.IO.Stream,``0,System.Text.Json.JsonSerializerOptions)
    Present Present Missing NA M:System.Text.Json.JsonSerializer.Serialize``1(System.IO.Stream,``0,System.Text.Json.Serialization.Metadata.JsonTypeInfo{``0})
    Present Present Missing NA M:System.Text.Json.JsonSerializer.Serialize``1(System.Text.Json.Utf8JsonWriter,``0,System.Text.Json.Serialization.Metadata.JsonTypeInfo{``0})
    Present Present Missing Present M:System.Text.Json.JsonSerializer.SerializeAsync``1(System.IO.Stream,``0,System.Text.Json.Serialization.Metadata.JsonTypeInfo{``0},System.Threading.CancellationToken)
    Present Present Missing Present M:System.Text.Json.JsonSerializer.SerializeToDocument``1(``0,System.Text.Json.JsonSerializerOptions)
    Present Present Missing Present M:System.Text.Json.JsonSerializer.SerializeToDocument``1(``0,System.Text.Json.Serialization.Metadata.JsonTypeInfo{``0})
    Present Present Missing Present M:System.Text.Json.JsonSerializer.SerializeToElement``1(``0,System.Text.Json.JsonSerializerOptions)
    Present Present Missing Present M:System.Text.Json.JsonSerializer.SerializeToElement``1(``0,System.Text.Json.Serialization.Metadata.JsonTypeInfo{``0})
    Present Present Missing Present M:System.Text.Json.JsonSerializer.SerializeToNode``1(``0,System.Text.Json.JsonSerializerOptions)
    Present Present Missing Present M:System.Text.Json.JsonSerializer.SerializeToNode``1(``0,System.Text.Json.Serialization.Metadata.JsonTypeInfo{``0})
    Present Present Missing Present M:System.Text.Json.JsonSerializer.SerializeToUtf8Bytes``1(``0,System.Text.Json.Serialization.Metadata.JsonTypeInfo{``0})
    Present NA Missing Missing M:System.Text.Json.Nodes.JsonNode.GetValue``1
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Explicit(System.Text.Json.Nodes.JsonNode)~System.Nullable{System.UInt16}
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Explicit(System.Text.Json.Nodes.JsonNode)~System.Nullable{System.Guid}
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Explicit(System.Text.Json.Nodes.JsonNode)~System.Nullable{System.UInt32}
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Explicit(System.Text.Json.Nodes.JsonNode)~System.Single
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Explicit(System.Text.Json.Nodes.JsonNode)~System.SByte
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Explicit(System.Text.Json.Nodes.JsonNode)~System.Nullable{System.Double}
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Explicit(System.Text.Json.Nodes.JsonNode)~System.String
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Explicit(System.Text.Json.Nodes.JsonNode)~System.UInt16
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Explicit(System.Text.Json.Nodes.JsonNode)~System.UInt32
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Explicit(System.Text.Json.Nodes.JsonNode)~System.UInt64
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Explicit(System.Text.Json.Nodes.JsonNode)~System.Nullable{System.UInt64}
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Explicit(System.Text.Json.Nodes.JsonNode)~System.Nullable{System.Decimal}
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Explicit(System.Text.Json.Nodes.JsonNode)~System.Nullable{System.Int32}
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Explicit(System.Text.Json.Nodes.JsonNode)~System.Nullable{System.DateTime}
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Explicit(System.Text.Json.Nodes.JsonNode)~System.Nullable{System.DateTimeOffset}
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Explicit(System.Text.Json.Nodes.JsonNode)~System.Nullable{System.SByte}
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Explicit(System.Text.Json.Nodes.JsonNode)~System.Char
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Explicit(System.Text.Json.Nodes.JsonNode)~System.DateTime
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Explicit(System.Text.Json.Nodes.JsonNode)~System.DateTimeOffset
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Explicit(System.Text.Json.Nodes.JsonNode)~System.Decimal
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Explicit(System.Text.Json.Nodes.JsonNode)~System.Double
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Explicit(System.Text.Json.Nodes.JsonNode)~System.Boolean
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Explicit(System.Text.Json.Nodes.JsonNode)~System.Int16
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Explicit(System.Text.Json.Nodes.JsonNode)~System.Int32
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Explicit(System.Text.Json.Nodes.JsonNode)~System.Int64
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Explicit(System.Text.Json.Nodes.JsonNode)~System.Nullable{System.Boolean}
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Explicit(System.Text.Json.Nodes.JsonNode)~System.Nullable{System.Byte}
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Explicit(System.Text.Json.Nodes.JsonNode)~System.Nullable{System.Char}
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Explicit(System.Text.Json.Nodes.JsonNode)~System.Guid
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Explicit(System.Text.Json.Nodes.JsonNode)~System.Nullable{System.Int64}
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Explicit(System.Text.Json.Nodes.JsonNode)~System.Nullable{System.Int16}
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Explicit(System.Text.Json.Nodes.JsonNode)~System.Nullable{System.Single}
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Explicit(System.Text.Json.Nodes.JsonNode)~System.Byte
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Implicit(System.Nullable{System.Double})~System.Text.Json.Nodes.JsonNode
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Implicit(System.Guid)~System.Text.Json.Nodes.JsonNode
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Implicit(System.Nullable{System.DateTime})~System.Text.Json.Nodes.JsonNode
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Implicit(System.Int16)~System.Text.Json.Nodes.JsonNode
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Implicit(System.Nullable{System.Char})~System.Text.Json.Nodes.JsonNode
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Implicit(System.Nullable{System.Byte})~System.Text.Json.Nodes.JsonNode
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Implicit(System.Nullable{System.Boolean})~System.Text.Json.Nodes.JsonNode
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Implicit(System.Int64)~System.Text.Json.Nodes.JsonNode
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Implicit(System.Int32)~System.Text.Json.Nodes.JsonNode
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Implicit(System.DateTime)~System.Text.Json.Nodes.JsonNode
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Implicit(System.Decimal)~System.Text.Json.Nodes.JsonNode
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Implicit(System.DateTimeOffset)~System.Text.Json.Nodes.JsonNode
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Implicit(System.Nullable{System.Decimal})~System.Text.Json.Nodes.JsonNode
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Implicit(System.Char)~System.Text.Json.Nodes.JsonNode
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Implicit(System.Boolean)~System.Text.Json.Nodes.JsonNode
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Implicit(System.Nullable{System.DateTimeOffset})~System.Text.Json.Nodes.JsonNode
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Implicit(System.Byte)~System.Text.Json.Nodes.JsonNode
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Implicit(System.Double)~System.Text.Json.Nodes.JsonNode
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Implicit(System.Nullable{System.Guid})~System.Text.Json.Nodes.JsonNode
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Implicit(System.Nullable{System.UInt64})~System.Text.Json.Nodes.JsonNode
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Implicit(System.Nullable{System.Int16})~System.Text.Json.Nodes.JsonNode
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Implicit(System.Nullable{System.Int32})~System.Text.Json.Nodes.JsonNode
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Implicit(System.Nullable{System.Int64})~System.Text.Json.Nodes.JsonNode
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Implicit(System.Nullable{System.Single})~System.Text.Json.Nodes.JsonNode
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Implicit(System.Nullable{System.UInt16})~System.Text.Json.Nodes.JsonNode
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Implicit(System.Nullable{System.UInt32})~System.Text.Json.Nodes.JsonNode
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Implicit(System.Nullable{System.SByte})~System.Text.Json.Nodes.JsonNode
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Implicit(System.Single)~System.Text.Json.Nodes.JsonNode
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Implicit(System.SByte)~System.Text.Json.Nodes.JsonNode
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Implicit(System.String)~System.Text.Json.Nodes.JsonNode
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Implicit(System.UInt16)~System.Text.Json.Nodes.JsonNode
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Implicit(System.UInt32)~System.Text.Json.Nodes.JsonNode
    Present Present NA Missing M:System.Text.Json.Nodes.JsonNode.op_Implicit(System.UInt64)~System.Text.Json.Nodes.JsonNode
    Present Present Present Missing M:System.Text.Json.Serialization.Metadata.JsonMetadataServices.CreateArrayInfo``1(System.Text.Json.JsonSerializerOptions,System.Text.Json.Serialization.Metadata.JsonTypeInfo,System.Text.Json.Serialization.JsonNumberHandling,System.Action{System.Text.Json.Utf8JsonWriter,``0[]})
    Present Missing Present Missing M:System.Text.Json.Serialization.Metadata.JsonMetadataServices.CreateConcurrentQueueInfo``2(System.Text.Json.JsonSerializerOptions,System.Func{``0},System.Text.Json.Serialization.Metadata.JsonTypeInfo,System.Text.Json.Serialization.JsonNumberHandling,System.Action{System.Text.Json.Utf8JsonWriter,``0})
    Present Missing Present Missing M:System.Text.Json.Serialization.Metadata.JsonMetadataServices.CreateConcurrentStackInfo``2(System.Text.Json.JsonSerializerOptions,System.Func{``0},System.Text.Json.Serialization.Metadata.JsonTypeInfo,System.Text.Json.Serialization.JsonNumberHandling,System.Action{System.Text.Json.Utf8JsonWriter,``0})
    Present Missing Present Missing M:System.Text.Json.Serialization.Metadata.JsonMetadataServices.CreateDictionaryInfo``3(System.Text.Json.JsonSerializerOptions,System.Func{``0},System.Text.Json.Serialization.Metadata.JsonTypeInfo,System.Text.Json.Serialization.Metadata.JsonTypeInfo,System.Text.Json.Serialization.JsonNumberHandling,System.Action{System.Text.Json.Utf8JsonWriter,``0})
    Present Missing Present Missing M:System.Text.Json.Serialization.Metadata.JsonMetadataServices.CreateICollectionInfo``2(System.Text.Json.JsonSerializerOptions,System.Func{``0},System.Text.Json.Serialization.Metadata.JsonTypeInfo,System.Text.Json.Serialization.JsonNumberHandling,System.Action{System.Text.Json.Utf8JsonWriter,``0})
    Present Missing Present Missing M:System.Text.Json.Serialization.Metadata.JsonMetadataServices.CreateIDictionaryInfo``3(System.Text.Json.JsonSerializerOptions,System.Func{``0},System.Text.Json.Serialization.Metadata.JsonTypeInfo,System.Text.Json.Serialization.Metadata.JsonTypeInfo,System.Text.Json.Serialization.JsonNumberHandling,System.Action{System.Text.Json.Utf8JsonWriter,``0})
    Present Missing Present Missing M:System.Text.Json.Serialization.Metadata.JsonMetadataServices.CreateIDictionaryInfo``1(System.Text.Json.JsonSerializerOptions,System.Func{``0},System.Text.Json.Serialization.Metadata.JsonTypeInfo,System.Text.Json.Serialization.Metadata.JsonTypeInfo,System.Text.Json.Serialization.JsonNumberHandling,System.Action{System.Text.Json.Utf8JsonWriter,``0})
    Present Missing Present Missing M:System.Text.Json.Serialization.Metadata.JsonMetadataServices.CreateIEnumerableInfo``2(System.Text.Json.JsonSerializerOptions,System.Func{``0},System.Text.Json.Serialization.Metadata.JsonTypeInfo,System.Text.Json.Serialization.JsonNumberHandling,System.Action{System.Text.Json.Utf8JsonWriter,``0})
    Present Missing Present Missing M:System.Text.Json.Serialization.Metadata.JsonMetadataServices.CreateIEnumerableInfo``1(System.Text.Json.JsonSerializerOptions,System.Func{``0},System.Text.Json.Serialization.Metadata.JsonTypeInfo,System.Text.Json.Serialization.JsonNumberHandling,System.Action{System.Text.Json.Utf8JsonWriter,``0})
    Present Missing Present Missing M:System.Text.Json.Serialization.Metadata.JsonMetadataServices.CreateIListInfo``2(System.Text.Json.JsonSerializerOptions,System.Func{``0},System.Text.Json.Serialization.Metadata.JsonTypeInfo,System.Text.Json.Serialization.JsonNumberHandling,System.Action{System.Text.Json.Utf8JsonWriter,``0})
    Present Missing Present Missing M:System.Text.Json.Serialization.Metadata.JsonMetadataServices.CreateIListInfo``1(System.Text.Json.JsonSerializerOptions,System.Func{``0},System.Text.Json.Serialization.Metadata.JsonTypeInfo,System.Text.Json.Serialization.JsonNumberHandling,System.Action{System.Text.Json.Utf8JsonWriter,``0})
    Present Missing Present Missing M:System.Text.Json.Serialization.Metadata.JsonMetadataServices.CreateImmutableDictionaryInfo``3(System.Text.Json.JsonSerializerOptions,System.Func{``0},System.Text.Json.Serialization.Metadata.JsonTypeInfo,System.Text.Json.Serialization.Metadata.JsonTypeInfo,System.Text.Json.Serialization.JsonNumberHandling,System.Action{System.Text.Json.Utf8JsonWriter,``0},System.Func{System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{``1,``2}},``0})
    Present Missing Present Missing M:System.Text.Json.Serialization.Metadata.JsonMetadataServices.CreateImmutableEnumerableInfo``2(System.Text.Json.JsonSerializerOptions,System.Func{``0},System.Text.Json.Serialization.Metadata.JsonTypeInfo,System.Text.Json.Serialization.JsonNumberHandling,System.Action{System.Text.Json.Utf8JsonWriter,``0},System.Func{System.Collections.Generic.IEnumerable{``1},``0})
    Present Missing Present Missing M:System.Text.Json.Serialization.Metadata.JsonMetadataServices.CreateIReadOnlyDictionaryInfo``3(System.Text.Json.JsonSerializerOptions,System.Func{``0},System.Text.Json.Serialization.Metadata.JsonTypeInfo,System.Text.Json.Serialization.Metadata.JsonTypeInfo,System.Text.Json.Serialization.JsonNumberHandling,System.Action{System.Text.Json.Utf8JsonWriter,``0})
    Present Missing Present Missing M:System.Text.Json.Serialization.Metadata.JsonMetadataServices.CreateISetInfo``2(System.Text.Json.JsonSerializerOptions,System.Func{``0},System.Text.Json.Serialization.Metadata.JsonTypeInfo,System.Text.Json.Serialization.JsonNumberHandling,System.Action{System.Text.Json.Utf8JsonWriter,``0})
    Present Missing Present Missing M:System.Text.Json.Serialization.Metadata.JsonMetadataServices.CreateListInfo``2(System.Text.Json.JsonSerializerOptions,System.Func{``0},System.Text.Json.Serialization.Metadata.JsonTypeInfo,System.Text.Json.Serialization.JsonNumberHandling,System.Action{System.Text.Json.Utf8JsonWriter,``0})
    Present Missing Present Missing M:System.Text.Json.Serialization.Metadata.JsonMetadataServices.CreateQueueInfo``2(System.Text.Json.JsonSerializerOptions,System.Func{``0},System.Text.Json.Serialization.Metadata.JsonTypeInfo,System.Text.Json.Serialization.JsonNumberHandling,System.Action{System.Text.Json.Utf8JsonWriter,``0})
    Present Missing Present Missing M:System.Text.Json.Serialization.Metadata.JsonMetadataServices.CreateStackInfo``2(System.Text.Json.JsonSerializerOptions,System.Func{``0},System.Text.Json.Serialization.Metadata.JsonTypeInfo,System.Text.Json.Serialization.JsonNumberHandling,System.Action{System.Text.Json.Utf8JsonWriter,``0})
    Present Missing Present Missing M:System.Text.Json.Serialization.Metadata.JsonMetadataServices.CreateStackOrQueueInfo``1(System.Text.Json.JsonSerializerOptions,System.Func{``0},System.Text.Json.Serialization.Metadata.JsonTypeInfo,System.Text.Json.Serialization.JsonNumberHandling,System.Action{System.Text.Json.Utf8JsonWriter,``0},System.Action{``0,System.Object})
    Present Missing Present Present M:System.Text.Json.Serialization.Metadata.JsonMetadataServices.CreateValueInfo``1(System.Text.Json.JsonSerializerOptions,System.Text.Json.Serialization.JsonConverter)
    Present Present Present Missing M:System.Text.Json.Serialization.Metadata.JsonMetadataServices.GetEnumConverter``1(System.Text.Json.JsonSerializerOptions)
    Present Present Present Missing M:System.Text.Json.Serialization.Metadata.JsonMetadataServices.GetNullableConverter``1(System.Text.Json.Serialization.Metadata.JsonTypeInfo{``0})

  17. eiriktsarpalis commented on Sep 13, 2021

    @eiriktsarpalis
    eiriktsarpalis
    on Sep 13, 2021
    Member

    @carlossanlop some of the methods marked as missing documentation are actually overrides marked with the <inheritdoc/> elements, for example

    runtime/src/libraries/System.Text.Json/src/System/Text/Json/Nodes/JsonObject.cs

    Lines 84 to 85 in 44996f8

    /// <inheritdoc/>
    public override void WriteTo(Utf8JsonWriter writer, JsonSerializerOptions? options = null)

    What's best practice in this case? Do we really need to duplicate documentation in this case?

    So if I exclude SourceGeneration, this is the list of APIs that need some documentation.

    Note that the System.Text.Json.Metadata namespace provides runtime APIs for sourcegen, so should be excluded as well.

  18. carlossanlop commented on Sep 13, 2021

    @carlossanlop
    carlossanlop
    on Sep 13, 2021
    ContributorAuthor

    @eiriktsarpalis I fixed DocsPortingTool recently to detect the <inheritdoc/> tag and collect the documentation from the parent API.

  19. eiriktsarpalis commented on Sep 13, 2021

    @eiriktsarpalis
    eiriktsarpalis
    on Sep 13, 2021
    Member

    Fixed by dotnet/dotnet-api-docs#7157

  20. eiriktsarpalis
    closed this as completedon Sep 13, 2021

  21. carlossanlop commented on Sep 13, 2021

    @carlossanlop
    carlossanlop
    on Sep 13, 2021
    ContributorAuthor

    Thanks, @eiriktsarpalis for the PR!

    I noticed several APIs are op_explicit or op_implicit inherited members. Adding the <inheritdoc/> documentation tag was the correct thing to do, but unfortunately the parent APIs are not documented, so nothing can be ported. Since the parent API is not really part of your namespace, I am going to exclude those from the undoc list.

    @steveharter @layomia there are still a few that were not covered in the last PR, can you please take care of them? Reminder that today is the last day to merge to the net6-rc1 branch in dotnet-api-docs, before we snap.

    Undoc APIs
    M:System.Text.Json.JsonSerializer.Serialize(System.Text.Json.Utf8JsonWriter,System.Object,System.Type,System.Text.Json.Serialization.JsonSerializerContext)
    M:System.Text.Json.JsonSerializer.SerializeToUtf8Bytes``1(``0,System.Text.Json.Serialization.Metadata.JsonTypeInfo{``0})
    N:System.Text.Json.Nodes
    M:System.Text.Json.Nodes.JsonArray.WriteTo(System.Text.Json.Utf8JsonWriter,System.Text.Json.JsonSerializerOptions)
    M:System.Text.Json.Nodes.JsonNode.GetValue``1
    M:System.Text.Json.Nodes.JsonObject.WriteTo(System.Text.Json.Utf8JsonWriter,System.Text.Json.JsonSerializerOptions)
    M:System.Text.Json.Serialization.JsonSourceGenerationOptionsAttribute.#ctor
  22. carlossanlop
    reopened this on Sep 13, 2021

  23. eiriktsarpalis commented on Sep 14, 2021

    @eiriktsarpalis
    eiriktsarpalis
    on Sep 14, 2021
    Member

    Fixed in dotnet/dotnet-api-docs#7180

  24. eiriktsarpalis
    closed this as completedon Sep 14, 2021
  25. ghost locked as resolved and limited conversation to collaborators on Nov 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

area-System.Text.JsondocumentationDocumentation bug or enhancement, does not impact product or test code

Type

No type

Projects

No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions