Skip to content

Add XML documentation for Java.Time - #651

Merged
jonathanpeppers merged 2 commits into
mainfrom
jonathanpeppers-add-java-time-xml-docs
Aug 19, 2026
Merged

Add XML documentation for Java.Time#651
jonathanpeppers merged 2 commits into
mainfrom
jonathanpeppers-add-java-time-xml-docs

Conversation

@jonathanpeppers

Copy link
Copy Markdown
Member

Closes#276.

Imports 2,007 exact To be added XML documentation elements across 15 Java.Time files from official Java 21 API documentation using tools/importer.cs.

The importer self-test passed. All batches were run with --path docs\xml\Java.Time --namespace Java.Time --max-changes 10; subsequent batches used the populated cache in offline mode. All changed XML files parsed successfully and git diff --check passed.

The final scoped dry run found no further exact matches. It conservatively retained 510 placeholders that could not be safely sourced: 460 missing member registrations, 26 members absent from the declared source page, and 24 overload signature mismatches.

Import exact Java.Time placeholder documentation from official Java API sources.
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 0db26b22-70e2-484d-a334-f48cf3d13a71
CopilotAI lite review requested due to automatic review settings August 18, 2026 21:53

CopilotAI 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 addresses issue #276 by reducing To be added placeholders in the Java.Time XML documentation set, importing exact documentation elements from the official Java 21 API docs via tools/importer.cs.

Changes:

  • Imported XML doc content for numerous Java.Time members (summaries/params/returns/remarks) from Java 21 reference pages.
  • Added Oracle Java reference links in remarks for many updated members.
  • Left a set of placeholders intact where the importer could not safely match source documentation (per PR description).

Reviewed changes

Copilot reviewed 15 out of 15 changed files in this pull request and generated 6 comments.

Show a summary per file
FileDescription
docs/xml/Java.Time/ZoneId.xmlReplaces placeholders with Java 21 docs for several ZoneId members and adds reference links.
docs/xml/Java.Time/YearMonth.xmlReplaces placeholders with Java 21 docs for multiple YearMonth members and adds reference links.
docs/xml/Java.Time/Year.xmlReplaces placeholders with Java 21 docs for multiple Year members and adds reference links.
docs/xml/Java.Time/Period.xmlReplaces placeholders with Java 21 docs for Period members and adds reference links.
docs/xml/Java.Time/MonthDay.xmlReplaces placeholders with Java 21 docs for MonthDay members and adds reference links.
docs/xml/Java.Time/Month.xmlFills in placeholder docs for Month.valueOf and adds a reference link.
docs/xml/Java.Time/LocalTime.xmlReplaces placeholders with Java 21 docs for multiple LocalTime members and adds reference links.
docs/xml/Java.Time/Duration.xmlReplaces placeholders with Java 21 docs for multiple Duration members and adds reference links.
docs/xml/Java.Time/DayOfWeek.xmlFills in placeholder docs for DayOfWeek.valueOf and adds a reference link.
docs/xml/Java.Time/Clock.xmlReplaces placeholders with Java 21 docs for several Clock members and adds reference links.
Suppressed comments (2)

docs/xml/Java.Time/Period.xml:572

  • The text for monthsToSubtract says "years" but this method subtracts months; this is incorrect documentation.
 <param name="monthsToSubtract">the years to subtract, positive or negative</param>

docs/xml/Java.Time/Duration.xml:2499

  • The text says "based on this period" but this member is on Duration; this looks like a copy/paste error.
 <returns>a Duration based on this period with the requested seconds, not null</returns>

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment threaddocs/xml/Java.Time/Period.xml Outdated
Comment threaddocs/xml/Java.Time/Period.xml Outdated
Comment threaddocs/xml/Java.Time/Duration.xml Outdated
Comment threaddocs/xml/Java.Time/Duration.xml Outdated
Comment threaddocs/xml/Java.Time/ZoneId.xml Outdated
Comment threaddocs/xml/Java.Time/ZoneId.xml Outdated
@jonathanpeppers

Copy link
Copy Markdown
MemberAuthor

@dalexsoto review

@dalexsotodalexsoto 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.

Six Java.Time import errors remain:

  • Period.MinusDays says months and MinusMonths says years.
  • Period.MultipliedBy(int) incorrectly says the value-type scalar is non-null.
  • Duration.MinusMinutes describes hours instead of minutes.
  • Duration.WithNanos and WithSeconds call the instance a period instead of a duration.
  • ZoneId.Normalized() describes a string ID rather than the returned ZoneId and contains the broken phrase “The returns”.

Please correct these source/import copy errors before merging.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 7a5c87d6-c5c6-4970-ace5-ce07c64bcbef
@jonathanpeppers

Copy link
Copy Markdown
MemberAuthor

@dalexsoto review

@dalexsotodalexsoto 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.

The Java.Time import now has correct units, value-type nullability, return types, wording, source links, and generated metadata across all 15 files.

@jonathanpeppers
jonathanpeppers merged commit a8d6deb into mainAug 19, 2026
3 checks passed
@jonathanpeppers
jonathanpeppers deleted the jonathanpeppers-add-java-time-xml-docs branch August 19, 2026 12:44
Sign up for freeto 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 Java.Time

3 participants

@jonathanpeppers@dalexsoto