summaryrefslogtreecommitdiff
path: root/sc/inc/address.hxx
diff options
context:
space:
mode:
authorKohei Yoshida <kohei.yoshida@collabora.com>2017-02-11 16:29:17 -0500
committerKohei Yoshida <kohei.yoshida@collabora.com>2017-02-11 17:02:57 -0500
commit2aea0d0148ea0940da2b32387c330f9aa590294c (patch)
tree65a5669a6c62fee61d3220dd4f34e51948720e85 /sc/inc/address.hxx
parent5fea81e4bfc2372563c0612f95406ca34fdd2c96 (diff)
Clarify what this method does. Also remove inaccuracies.
Change-Id: I2d6bda3dccb2040558bd7d4daa9d9b3b43b2d528
Diffstat (limited to 'sc/inc/address.hxx')
-rw-r--r--sc/inc/address.hxx10
1 files changed, 9 insertions, 1 deletions
diff --git a/sc/inc/address.hxx b/sc/inc/address.hxx
index 05f62b4d7110..dc1e066fe800 100644
--- a/sc/inc/address.hxx
+++ b/sc/inc/address.hxx
@@ -350,7 +350,15 @@ public:
inline size_t hash() const;
- /// "A1" or "$A$1" or R1C1 or R[1]C[1]
+ /**
+ * Create a human-readable string representation of the cell address. You
+ * cannot specify precise formatting with this method; use Format() if you
+ * need to specify how the address needs to be formatted.
+ *
+ * The address string does not display sheet name.
+ *
+ * @return human-readable string representation of the cell address.
+ */
OUString GetColRowString() const;
};