ICU-13700 APIDoc tweaks for getMultiplierScale/setMultiplierScale.
authorShane Carr <shane@unicode.org>
Thu, 19 Apr 2018 00:14:17 +0000 (00:14 +0000)
committerShane Carr <shane@unicode.org>
Thu, 19 Apr 2018 00:14:17 +0000 (00:14 +0000)
X-SVN-Rev: 41247

icu4c/source/i18n/unicode/decimfmt.h

index 0bee8ffb350bdb38a09494c31c7fba44ad9bfa1f..b55036f78a5b307a427e5bce6263fee789080874 100644 (file)
@@ -1333,8 +1333,11 @@ class U_I18N_API DecimalFormat : public NumberFormat {
     virtual void setMultiplier(int32_t newValue);
 
     /**
-     * Gets a multiplier for the given power of ten.
-     * For example, scale of 2 corresponds to a multiplier of 100.
+     * Gets the power of ten by which number should be multiplied before formatting, which
+     * can be combined with setMultiplier() to multiply by any arbitrary decimal value.
+     *
+     * A multiplier scale of 2 corresponds to multiplication by 100, and a multiplier scale
+     * of -2 corresponds to multiplication by 0.01.
      *
      * This method is analogous to UNUM_SCALE in getAttribute.
      *
@@ -1347,6 +1350,9 @@ class U_I18N_API DecimalFormat : public NumberFormat {
      * Sets a power of ten by which number should be multiplied before formatting, which
      * can be combined with setMultiplier() to multiply by any arbitrary decimal value.
      *
+     * A multiplier scale of 2 corresponds to multiplication by 100, and a multiplier scale
+     * of -2 corresponds to multiplication by 0.01.
+     *
      * For example, to multiply numbers by 0.5 before formatting, you can do:
      *
      * <pre>