docs: DOC-1179: JS API - Wrapper class docs#7775
docs: DOC-1179: JS API - Wrapper class docs#7775elijahpetty wants to merge 1 commit intodeephaven:mainfrom
Conversation
elijahpetty
added
NoDocumentationNeeded
NoReleaseNotesNeeded
No docs changes detected for 6a36baf |
There was a problem hiding this comment.
Pull request overview
Updates JS client API wrapper classes with clearer Javadoc to improve generated documentation and clarify JS-facing conversion helpers.
Changes:
- Added/expanded Javadoc on numeric wrappers (
LongWrapper,BigIntegerWrapper,BigDecimalWrapper) covering parsing, numeric conversion, andvalueOf()/toString(). - Added Javadoc clarifying
DateWrapperepoch-nanos semantics and JSDateconversions. - Added Javadoc to
LocalDateWrapperdescribing field getters and string formatting.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| web/client-api/src/main/java/io/deephaven/web/client/api/LongWrapper.java | Adds class/method Javadoc for parsing and JS-friendly conversions (asNumber, valueOf, toString). |
| web/client-api/src/main/java/io/deephaven/web/client/api/LocalDateWrapper.java | Documents valueOf, date component getters, and toString formatting. |
| web/client-api/src/main/java/io/deephaven/web/client/api/DateWrapper.java | Adds class-level and method Javadoc for nanos timestamps and JsDate conversions. |
| web/client-api/src/main/java/io/deephaven/web/client/api/BigIntegerWrapper.java | Documents ofString, conversions, and equality/hash semantics. |
| web/client-api/src/main/java/io/deephaven/web/client/api/BigDecimalWrapper.java | Documents ofString, conversions, and equality/hash semantics. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
web/client-api/src/main/java/io/deephaven/web/client/api/LocalDateWrapper.java
Show resolved
Hide resolved
| * This type extends {@link LongWrapper} and inherits the following conversions: | ||
| * <ul> | ||
| * <li>{@link LongWrapper#asNumber()} for a numeric representation</li> | ||
| * <li>{@link LongWrapper#toString()} and {@link LongWrapper#valueOf()} for string representations</li> | ||
| * <li>{@link LongWrapper#ofString(String)} for parsing</li> | ||
| * </ul> |
There was a problem hiding this comment.
The class Javadoc says DateWrapper “inherits … LongWrapper#ofString(String) for parsing”, but ofString returns a LongWrapper, not a DateWrapper. In JS, calling DateWrapper.ofString(...) would produce an instance without asDate(), which is surprising. Consider either adding a DateWrapper.ofString(String) that returns a DateWrapper, or adjusting the Javadoc to avoid implying a parsing API specific to DateWrapper.
No description provided.