[JAVA-4799] Document: Javadocs for the expression API Created: 02/Nov/22 Updated: 28/Oct/23 Resolved: 31/Jan/23 |
|
| Status: | Closed |
| Project: | Java Driver |
| Component/s: | None |
| Affects Version/s: | None |
| Fix Version/s: | 4.9.0 |
| Type: | Improvement | Priority: | Unknown |
| Reporter: | Maxim Katcharov | Assignee: | Maxim Katcharov |
| Resolution: | Fixed | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Epic Link: | Expression builders |
| Quarter: | FY23Q4 |
| Description |
|
Any javadocs on the Expression interfaces (and the Expressions utility class) that are merged in to the expressions branch are considered tentative until this ticket is resolved, and methods might lack docs entirely. This does not apply to work outside of the Expression interfaces/Expressions class. It is not obvious how the docs should be written. For example, "returns logical true if this Expression is evaluated to false" seems awkward and confusing, possibly because it mixes concepts from a variety of levels: abstract values, the specific interface, the idea of evaluation, the semantics versus the implementation, and so on. We would need to have a careful look at how JDK or other similar library javadoc might have solved some of these problems.
|
| Comments |
| Comment by Githook User [ 31/Jan/23 ] |
|
Author: {'name': 'Maxim Katcharov', 'email': 'maxim.katcharov@mongodb.com', 'username': 'katcharov'}Message: Add MQL Expressions (#1032)
Implement arithmetic expressions (from top 50, and others)
Rename extractBsonValue Fix access modifiers Remove excess comments Update docs Fix: behaviour of get Add notNull to API, add notNullApi test Fix docs/annotations, tests Fix docs, annotations, since Fix docs Revert external Add missing MqlUnchecked Fix missing null checks Checkstyle
--------- Co-authored-by: Valentin Kovalenko <valentin.kovalenko@mongodb.com> |