summaryrefslogtreecommitdiff
path: root/svl/inc/svl
diff options
context:
space:
mode:
authorKohei Yoshida <kyoshida@novell.com>2011-02-25 11:46:37 -0500
committerKohei Yoshida <kyoshida@novell.com>2011-02-28 10:39:31 -0500
commit6aad3e48b43a637efc372b448298102866e6dc8b (patch)
tree8bf072f69504a62a7ada1edc4a252523d60a2919 /svl/inc/svl
parent03fb9403784a137800c5c1a45c4e85eeb2eab62f (diff)
Updated method documentation.
Diffstat (limited to 'svl/inc/svl')
-rw-r--r--svl/inc/svl/zformat.hxx20
1 files changed, 12 insertions, 8 deletions
diff --git a/svl/inc/svl/zformat.hxx b/svl/inc/svl/zformat.hxx
index 298c1e4208e2..fe59468ad67d 100644
--- a/svl/inc/svl/zformat.hxx
+++ b/svl/inc/svl/zformat.hxx
@@ -502,14 +502,18 @@ private:
};
/**
- * Parse the content of '[$-xxx] or '[$-xxxxxxxx]' and extract the
- * language type from it. Given the string, start parsing at position
- * specified by nPos, and store the end position with nPos when the
- * parsing is complete. The nPos should point to the '$' before the
- * parsing, and to the closing bracket after the parsing. When the
- * content is [$-xxx], the xxx part represents the language type (aka
- * LCID) in hex numerals. When the content is [$-xxxxxxxx] the last 4
- * digits is the LCID (again in hex).
+ * Parse the content of '[$-xxx] or '[$-xxxxxxxx]' and extract the locale
+ * type from it. Given the string, start parsing at position specified by
+ * nPos, and store the end position with nPos when the parsing is
+ * complete. The nPos should point to the '$' before the parsing, and to
+ * the closing bracket after the parsing. When the content is [$-xxx],
+ * the xxx part represents the language type (aka LCID) in hex numerals.
+ * When the content is [$-xxxxxxxx] the last 4 digits represent the LCID
+ * (again in hex), the next 2 digits represent the calendar type, and the
+ * 2 highest digits (if exists) is the numeral shape.
+ *
+ * @reference
+ * http://office.microsoft.com/en-us/excel-help/creating-international-number-formats-HA001034635.aspx
*
* @param rString input string
* @param nPos position (see above).