Document Org.W3c.Dom.LS APIs - #604
Conversation
Refs #292 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR completes XML documentation for the Org.W3c.Dom.LS namespace by replacing remaining To be added placeholders with meaningful summaries, parameter descriptions, return/value text, and namespace/type descriptions, aligning these docs with the rest of the repository’s Android API reference-style XML documentation.
Changes:
- Documented
Org.W3c.Dom.LSnamespace summary (ns-Org.W3c.Dom.LS.xml). - Filled in missing constructor/property docs for
LSExceptionand key API surface docs across parser/serializer types. - Added/expanded extension-method documentation for async parser and serializer task wrappers.
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/xml/Org.W3c.Dom.LS/LSException.xml | Replaces placeholders with constructor/property documentation (including error code/message semantics). |
| docs/xml/Org.W3c.Dom.LS/ILSSerializerExtensions.xml | Documents async serializer extension methods (params/summary/returns). |
| docs/xml/Org.W3c.Dom.LS/ILSSerializer.xml | Documents serializer properties (DOM config, newline sequence). |
| docs/xml/Org.W3c.Dom.LS/ILSParserFilter.xml | Documents WhatToShow value description. |
| docs/xml/Org.W3c.Dom.LS/ILSParserExtensions.xml | Documents async parser extension methods (params/summary/returns). |
| docs/xml/Org.W3c.Dom.LS/ILSParser.xml | Documents parser properties (Async, Busy, DomConfig, Filter). |
| docs/xml/Org.W3c.Dom.LS/ILSInput.xml | Documents input source properties (streams, URIs, identifiers, encoding, etc.). |
| docs/xml/Org.W3c.Dom.LS/DOMImplementationLS.xml | Documents the type’s purpose as a factory for Load/Save objects. |
| docs/xml/ns-Org.W3c.Dom.LS.xml | Adds a namespace-level summary describing the Load/Save API purpose. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
|
@dalexsoto review |
dalexsoto
left a comment
There was a problem hiding this comment.
Two DOM LS contracts remain inaccurate:
DOMImplementationLSexposes only obsolete parser-mode constants; factory methods belong toIDOMImplementationLS.ParseAsync/ParseURIAsyncmerely wrap the underlying calls and can yield null for native asynchronous parsers; their Tasks do not necessarily represent parse completion.
Please correct the constants-holder summary and document the nullable wrapper behavior.
Refs #292 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: b8346aa6-1219-4050-9531-fe1fcd2999e9
|
Addressed the requested DOM LS contract corrections in 9cfc86c: DOMImplementationLS is documented only as the obsolete parser-mode constants holder, and ParseAsync/ParseURIAsync now state that native asynchronous parsers yield |
dalexsoto
left a comment
There was a problem hiding this comment.
DOMImplementationLS and the async parser wrappers now accurately describe the managed constants-holder, nullable results, and native completion semantics.
Pull request was closed
Closes #292
Summary
Org.W3c.Dom.LSnamespace and its remaining input, parser, serializer, exception, and task-wrapper API documentation.To be addedplaceholders present in this checkout's editable namespace XML files. (docs/xml/index.xmlwas not modified.)Sources
Validation
git diff --check.Org.W3c.Dom.LSXML andns-Org.W3c.Dom.LS.xml.To be addedplaceholders in the editable scoped XML files.