]> granicus.if.org Git - icu/commitdiff
ICU-10640 Improve documentation.
authorTravis Keep <keep94@gmail.com>
Sun, 16 Feb 2014 07:36:36 +0000 (07:36 +0000)
committerTravis Keep <keep94@gmail.com>
Sun, 16 Feb 2014 07:36:36 +0000 (07:36 +0000)
X-SVN-Rev: 35147

icu4c/source/i18n/unicode/measfmt.h

index c8edcbf3737dba9d343fcdfdad4ee28d78cde036..cdd9971978df495d1fedf104fd22f40f5df75067 100644 (file)
@@ -161,8 +161,13 @@ class U_I18N_API MeasureFormat : public Format {
             ParsePosition &pos) const;
 
     /**
-     * Formats measure objects to produce a string.
-     * @param measures measure objects.
+     * Formats measure objects to produce a string. An example of such a
+     * formatted string is 3 meters, 3.5 centimeters. Measure objects appear
+     * in the formatted string in the same order they appear in the "measures"
+     * array. The NumberFormat of this object is used only to format the amount
+     * of the very last measure. The other amounts are formatted with zero
+     * decimal places while rounding toward zero.
+     * @param measures array of measure objects.
      * @param measureCount the number of measure objects.
      * @param appendTo formatted string appended here.
      * @param pos the field position.