Uh oh!
There was an error while loading. Please reload this page.
Add XML documentation for Java.Time - #651
Conversation
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
There was a problem hiding this comment.
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.Timemembers (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
| File | Description |
|---|---|
| docs/xml/Java.Time/ZoneId.xml | Replaces placeholders with Java 21 docs for several ZoneId members and adds reference links. |
| docs/xml/Java.Time/YearMonth.xml | Replaces placeholders with Java 21 docs for multiple YearMonth members and adds reference links. |
| docs/xml/Java.Time/Year.xml | Replaces placeholders with Java 21 docs for multiple Year members and adds reference links. |
| docs/xml/Java.Time/Period.xml | Replaces placeholders with Java 21 docs for Period members and adds reference links. |
| docs/xml/Java.Time/MonthDay.xml | Replaces placeholders with Java 21 docs for MonthDay members and adds reference links. |
| docs/xml/Java.Time/Month.xml | Fills in placeholder docs for Month.valueOf and adds a reference link. |
| docs/xml/Java.Time/LocalTime.xml | Replaces placeholders with Java 21 docs for multiple LocalTime members and adds reference links. |
| docs/xml/Java.Time/Duration.xml | Replaces placeholders with Java 21 docs for multiple Duration members and adds reference links. |
| docs/xml/Java.Time/DayOfWeek.xml | Fills in placeholder docs for DayOfWeek.valueOf and adds a reference link. |
| docs/xml/Java.Time/Clock.xml | Replaces 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.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
jonathanpeppers
commented
Aug 18, 2026
@dalexsoto review |
dalexsoto
left a comment
There was a problem hiding this comment.
Six Java.Time import errors remain:
Period.MinusDayssays months andMinusMonthssays years.Period.MultipliedBy(int)incorrectly says the value-type scalar is non-null.Duration.MinusMinutesdescribes hours instead of minutes.Duration.WithNanosandWithSecondscall 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
commented
Aug 19, 2026
@dalexsoto review |
dalexsoto
left a comment
There was a problem hiding this comment.
The Java.Time import now has correct units, value-type nullability, return types, wording, source links, and generated metadata across all 15 files.
Uh oh!
There was an error while loading. Please reload this page.
Closes#276.
Imports 2,007 exact
To be addedXML documentation elements across 15Java.Timefiles from official Java 21 API documentation usingtools/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 andgit diff --checkpassed.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.