Skip to content

Add missing STJ docs#9297

Merged
eiriktsarpalis merged 10 commits into
dotnet:mainfrom
eiriktsarpalis:add-missing-json-docs
Sep 15, 2023
Merged

Add missing STJ docs#9297
eiriktsarpalis merged 10 commits into
dotnet:mainfrom
eiriktsarpalis:add-missing-json-docs

Conversation

@eiriktsarpalis

Copy link
Copy Markdown
Member

@ghost

ghost commented Sep 15, 2023

Copy link
Copy Markdown

Tagging subscribers to this area: @dotnet/area-system-text-json
See info in area-owners.md if you want to be subscribed.

Issue Details

Fix dotnet/runtime#88577

Author: eiriktsarpalis
Assignees: eiriktsarpalis
Labels:

area-System.Text.Json

Milestone: -

Comment thread xml/System.Text.Json.Serialization/BinaryDataJsonConverter.xml

@carlossanlop carlossanlop left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some suggestions for you to consider, @eiriktsarpalis. Otherwise, LGTM.

Comment thread xml/System.Text.Json.Nodes/JsonNode.xml Outdated
Comment thread xml/System.Text.Json.Nodes/JsonNode.xml Outdated
Comment thread xml/System.Text.Json/JsonSerializerOptions.xml Outdated
Comment thread xml/System.Text.Json.Nodes/JsonArray.xml Outdated
@learn-build-service-prod

This comment was marked as outdated.

eiriktsarpalis and others added 5 commits September 15, 2023 19:36
Co-authored-by: Carlos Sánchez López <1175054+carlossanlop@users.noreply.github.com>
Co-authored-by: Carlos Sánchez López <1175054+carlossanlop@users.noreply.github.com>
Co-authored-by: Carlos Sánchez López <1175054+carlossanlop@users.noreply.github.com>
Comment thread xml/System.Text.Json.Nodes/JsonArray.xml Outdated
Comment thread xml/System.Text.Json.Nodes/JsonArray.xml Outdated
@learn-build-service-prod

Copy link
Copy Markdown

Learn Build status updates of commit 8fa97e0:

💡 Validation status: suggestions

File Status Preview URL Details
xml/System.Text.Json.Serialization/BinaryDataJsonConverter.xml 💡Suggestion View Details
xml/System.Text.Json.Nodes/JsonArray.xml ✅Succeeded View
xml/System.Text.Json.Nodes/JsonNode.xml ✅Succeeded View
xml/System.Text.Json.Serialization/JsonConverter`1.xml ✅Succeeded View
xml/System.Text.Json.Serialization/JsonConverterFactory.xml ✅Succeeded View
xml/System.Text.Json.Serialization/JsonNumberEnumConverter`1.xml ✅Succeeded View
xml/System.Text.Json.Serialization/JsonObjectCreationHandlingAttribute.xml ✅Succeeded View
xml/System.Text.Json.Serialization/JsonStringEnumConverter`1.xml ✅Succeeded View
xml/System.Text.Json.Serialization/JsonUnmappedMemberHandlingAttribute.xml ✅Succeeded View
xml/System.Text.Json/JsonSerializer.xml ✅Succeeded View
xml/System.Text.Json/JsonSerializerOptions.xml ✅Succeeded View

xml/System.Text.Json.Serialization/BinaryDataJsonConverter.xml

  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NoFoundParent] Found no member can be inherited by key:Write(System.Text.Json.Utf8JsonWriter,System.BinaryData,System.Text.Json.JsonSerializerOptions) for uid: System.Text.Json.Serialization.BinaryDataJsonConverter.Write(System.Text.Json.Utf8JsonWriter,System.BinaryData,System.Text.Json.JsonSerializerOptions).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NoFoundDocs] Inheritdoc tag exists but no inheritdoc found for uid:System.Text.Json.Serialization.BinaryDataJsonConverter.Write(System.Text.Json.Utf8JsonWriter,System.BinaryData,System.Text.Json.JsonSerializerOptions).

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

@learn-build-service-prod

Copy link
Copy Markdown

Learn Build status updates of commit e52ae21:

💡 Validation status: suggestions

File Status Preview URL Details
xml/System.Text.Json.Serialization/BinaryDataJsonConverter.xml 💡Suggestion View Details
xml/System.Text.Json.Nodes/JsonArray.xml ✅Succeeded View
xml/System.Text.Json.Nodes/JsonNode.xml ✅Succeeded View
xml/System.Text.Json.Serialization/JsonConverter`1.xml ✅Succeeded View
xml/System.Text.Json.Serialization/JsonConverterFactory.xml ✅Succeeded View
xml/System.Text.Json.Serialization/JsonNumberEnumConverter`1.xml ✅Succeeded View
xml/System.Text.Json.Serialization/JsonObjectCreationHandlingAttribute.xml ✅Succeeded View
xml/System.Text.Json.Serialization/JsonStringEnumConverter`1.xml ✅Succeeded View
xml/System.Text.Json.Serialization/JsonUnmappedMemberHandlingAttribute.xml ✅Succeeded View
xml/System.Text.Json/JsonSerializer.xml ✅Succeeded View
xml/System.Text.Json/JsonSerializerOptions.xml ✅Succeeded View

xml/System.Text.Json.Serialization/BinaryDataJsonConverter.xml

  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NoFoundParent] Found no member can be inherited by key:Write(System.Text.Json.Utf8JsonWriter,System.BinaryData,System.Text.Json.JsonSerializerOptions) for uid: System.Text.Json.Serialization.BinaryDataJsonConverter.Write(System.Text.Json.Utf8JsonWriter,System.BinaryData,System.Text.Json.JsonSerializerOptions).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NoFoundDocs] Inheritdoc tag exists but no inheritdoc found for uid:System.Text.Json.Serialization.BinaryDataJsonConverter.Write(System.Text.Json.Utf8JsonWriter,System.BinaryData,System.Text.Json.JsonSerializerOptions).

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

Comment thread xml/System.Text.Json.Nodes/JsonArray.xml Outdated
eiriktsarpalis and others added 2 commits September 15, 2023 20:44
Co-authored-by: Carlos Sánchez López <1175054+carlossanlop@users.noreply.github.com>
@learn-build-service-prod

Copy link
Copy Markdown

Learn Build status updates of commit 3fae65e:

💡 Validation status: suggestions

File Status Preview URL Details
xml/System.Text.Json.Serialization/BinaryDataJsonConverter.xml 💡Suggestion View Details
xml/System.Text.Json.Nodes/JsonArray.xml ✅Succeeded View
xml/System.Text.Json.Nodes/JsonNode.xml ✅Succeeded View
xml/System.Text.Json.Serialization/JsonConverter`1.xml ✅Succeeded View
xml/System.Text.Json.Serialization/JsonConverterFactory.xml ✅Succeeded View
xml/System.Text.Json.Serialization/JsonNumberEnumConverter`1.xml ✅Succeeded View
xml/System.Text.Json.Serialization/JsonObjectCreationHandlingAttribute.xml ✅Succeeded View
xml/System.Text.Json.Serialization/JsonStringEnumConverter`1.xml ✅Succeeded View
xml/System.Text.Json.Serialization/JsonUnmappedMemberHandlingAttribute.xml ✅Succeeded View
xml/System.Text.Json/JsonSerializer.xml ✅Succeeded View
xml/System.Text.Json/JsonSerializerOptions.xml ✅Succeeded View

xml/System.Text.Json.Serialization/BinaryDataJsonConverter.xml

  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NoFoundParent] Found no member can be inherited by key:Write(System.Text.Json.Utf8JsonWriter,System.BinaryData,System.Text.Json.JsonSerializerOptions) for uid: System.Text.Json.Serialization.BinaryDataJsonConverter.Write(System.Text.Json.Utf8JsonWriter,System.BinaryData,System.Text.Json.JsonSerializerOptions).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NoFoundDocs] Inheritdoc tag exists but no inheritdoc found for uid:System.Text.Json.Serialization.BinaryDataJsonConverter.Write(System.Text.Json.Utf8JsonWriter,System.BinaryData,System.Text.Json.JsonSerializerOptions).

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

@learn-build-service-prod

Copy link
Copy Markdown

Learn Build status updates of commit d2baa63:

❌ Validation status: errors

Please follow instructions here which may help to resolve issue.

File Status Preview URL Details
❌Error Details
xml/System.Text.Json/JsonSerializerOptions.xml ❌Error Details

  • Line 0, Column 0: [Error: ECMA2Yaml_File_LoadFailed] Failed to load 1 files, aborting...

xml/System.Text.Json/JsonSerializerOptions.xml

  • Line 0, Column 0: [Error: ECMA2Yaml_InternalError]
Intenal Several Error: System.Xml.XmlException: The 'exception' start tag on line 790 position 10 does not match the end tag of 'para'. Line 791, position 225.
   at System.Xml.XmlTextReaderImpl.Throw(Exception e)
   at System.Xml.XmlTextReaderImpl.Throw(String res, String[] args)
   at System.Xml.XmlTextReaderImpl.ThrowTagMismatch(NodeData startTag)
   at System.Xml.XmlTextReaderImpl.ParseEndElement()
   at System.Xml.XmlTextReaderImpl.ParseElementContent()
   at System.Xml.Linq.XContainer.ReadContentFrom(XmlReader r)
   at System.Xml.Linq.XDocument.Load(XmlReader reader, LoadOptions options)
   at System.Xml.Linq.XDocument.Parse(String text, LoadOptions options)
   at ECMA2Yaml.ECMALoader.LoadType(FileItem typeFile)
   at ECMA2Yaml.ECMALoader.LoadTypes(String basePath, Namespace ns)

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

Comment thread xml/System.Text.Json/JsonSerializerOptions.xml Outdated
@learn-build-service-prod

Copy link
Copy Markdown

Learn Build status updates of commit 988d785:

💡 Validation status: suggestions

File Status Preview URL Details
xml/System.Text.Json.Serialization/BinaryDataJsonConverter.xml 💡Suggestion View Details
xml/System.Text.Json.Nodes/JsonArray.xml ✅Succeeded View
xml/System.Text.Json.Nodes/JsonNode.xml ✅Succeeded View
xml/System.Text.Json.Serialization/JsonConverter`1.xml ✅Succeeded View
xml/System.Text.Json.Serialization/JsonConverterFactory.xml ✅Succeeded View
xml/System.Text.Json.Serialization/JsonNumberEnumConverter`1.xml ✅Succeeded View
xml/System.Text.Json.Serialization/JsonObjectCreationHandlingAttribute.xml ✅Succeeded View
xml/System.Text.Json.Serialization/JsonStringEnumConverter`1.xml ✅Succeeded View
xml/System.Text.Json.Serialization/JsonUnmappedMemberHandlingAttribute.xml ✅Succeeded View
xml/System.Text.Json/JsonSerializer.xml ✅Succeeded View
xml/System.Text.Json/JsonSerializerOptions.xml ✅Succeeded View

xml/System.Text.Json.Serialization/BinaryDataJsonConverter.xml

  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NoFoundParent] Found no member can be inherited by key:Write(System.Text.Json.Utf8JsonWriter,System.BinaryData,System.Text.Json.JsonSerializerOptions) for uid: System.Text.Json.Serialization.BinaryDataJsonConverter.Write(System.Text.Json.Utf8JsonWriter,System.BinaryData,System.Text.Json.JsonSerializerOptions).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NoFoundDocs] Inheritdoc tag exists but no inheritdoc found for uid:System.Text.Json.Serialization.BinaryDataJsonConverter.Write(System.Text.Json.Utf8JsonWriter,System.BinaryData,System.Text.Json.JsonSerializerOptions).

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

@eiriktsarpalis eiriktsarpalis merged commit cab9492 into dotnet:main Sep 15, 2023
@eiriktsarpalis eiriktsarpalis deleted the add-missing-json-docs branch September 15, 2023 22:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Port System.Text.Json documentation for .NET 8.0 APIs

3 participants