Skip to content

Document Org.W3c.Dom.LS APIs - #604

Merged
jonathanpeppers merged 2 commits into
mainfrom
jonathanpeppers-document-w3c-dom-ls-apis
Aug 17, 2026
Merged

Document Org.W3c.Dom.LS APIs#604
jonathanpeppers merged 2 commits into
mainfrom
jonathanpeppers-document-w3c-dom-ls-apis

Conversation

@jonathanpeppers

Copy link
Copy Markdown
Member

Closes #292

Summary

  • Documents the Org.W3c.Dom.LS namespace and its remaining input, parser, serializer, exception, and task-wrapper API documentation.
  • Replaces all 50 To be added placeholders present in this checkout's editable namespace XML files. (docs/xml/index.xml was not modified.)

Sources

Validation

  • Parsed all 14 scoped XML files with PowerShell's XML parser.
  • Confirmed CRLF line endings are preserved in all scoped files.
  • Ran git diff --check.
  • Confirmed the diff is limited to Org.W3c.Dom.LS XML and ns-Org.W3c.Dom.LS.xml.
  • Confirmed zero remaining To be added placeholders in the editable scoped XML files.

Refs #292

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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.LS namespace summary (ns-Org.W3c.Dom.LS.xml).
  • Filled in missing constructor/property docs for LSException and 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.

@jonathanpeppers

Copy link
Copy Markdown
Member Author

@dalexsoto review

@dalexsoto dalexsoto left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Two DOM LS contracts remain inaccurate:

  • DOMImplementationLS exposes only obsolete parser-mode constants; factory methods belong to IDOMImplementationLS.
  • ParseAsync/ParseURIAsync merely 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
@jonathanpeppers

Copy link
Copy Markdown
Member Author

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
ull and that task completion does not indicate parse completion.

@dalexsoto dalexsoto left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

DOMImplementationLS and the async parser wrappers now accurately describe the managed constants-holder, nullable results, and native completion semantics.

auto-merge was automatically disabled August 17, 2026 21:07

Pull request was closed

@jonathanpeppers
jonathanpeppers enabled auto-merge (squash) August 17, 2026 21:07
@jonathanpeppers
jonathanpeppers merged commit 6f895ec into main Aug 17, 2026
3 checks passed
@jonathanpeppers
jonathanpeppers deleted the jonathanpeppers-document-w3c-dom-ls-apis branch August 17, 2026 21:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add XML documentation for Org.W3c.Dom.LS

3 participants