Use Advanced Search to search the entire archive.
[jsr363-experts] Trivial formatting proposals
- From: Martin Desruisseaux <
>
- To:
- Subject: [jsr363-experts] Trivial formatting proposals
- Date: Sat, 13 Dec 2014 21:05:59 +0900
- Organization: Geomatys
Following are very trivial formatting proposals (no code change), but
maybe they could help a little bit the reading?
* In Quantity, make Javadoc a little bit more explicit about the fact
that value and unit are the 2 main properties of a quantity.
* In Quantity, move the getValue() and getUnit() methods first since
they are the main properties of a quantity.
* In Quantity, move multiply methods before divide methods.
* In SystemOfUnits, add javadoc to the getName() method.
* In Unit, there is a javadoc formatting problem in many methods
(getSystemUnit(), asType(Class), alternate(String), etc.)
* In Unit, the getName() and getSymbol() javadoc should clarify in
which locale they are displayed. Or maybe those methods should have
a Locale argument?
* In Unit, move inverse() after divide methods for consistency with
the Quantity interface.
* In Unit, move root after pow method for consistency with the
Dimension interface and with the usual pattern of placing the
"simpler" method first, and its inverse after (add - subtract,
multiply - divide).
* In Unit, move toString() as the last method for consistency with
common usage. This will also keep transformmethod close to the other
methods that create a new unit.
Martin