Document org.json result metadata - #595
Merged
Merged
Conversation
Refs #262 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Updates XML documentation for Org.Json types by replacing remaining “To be added.” placeholders with concrete parameter/return/value descriptions aligned with the Android org.json references, improving the generated API docs for consumers.
Changes:
- Filled in missing
<returns>documentation for selectedJSONObjectandJSONArraymembers. - Replaced placeholder
<param>and<value>documentation with meaningful descriptions.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/xml/Org.Json/JSONObject.xml | Replaces placeholder return/value/param docs with concrete descriptions for selected members. |
| docs/xml/Org.Json/JSONArray.xml | Replaces placeholder return/param docs with concrete descriptions for selected members. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Refs #262 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
dalexsoto
approved these changes
Aug 16, 2026
dalexsoto
left a comment
dalexsoto
left a comment
Member
There was a problem hiding this comment.
The JSONArray and JSONObject result contracts, nullability, source links, and human-readable wording match Android with no remaining blocker.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Sources
JSONObjectreferenceJSONArrayreferenceValidation
org.jsonsource anchor.git diff --checkand confirmed the diff is limited to the twoOrg.JsonXML files.Refs #262
@dalexsoto please review.