Add note about order or row, column, and tab as fields vs. parameters

Change-Id: I45e0f9a95da20c1a3b6bdf2ac1387b3c14e3dad4

1 files changed, 6 insertions, 1 deletions

diff --git a/sc/inc/address.hxx b/sc/inc/address.hxx
index 3aab8862ecbd..e8c0092e14dc 100644
--- a/sc/inc/address.hxx
+++ b/sc/inc/address.hxx
@@ -1,4 +1,4 @@
-/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column:100 -*- */
 /*
  * This file is part of the LibreOffice project.
  *
@@ -187,6 +187,11 @@ inline void applyStartToEndFlags(ScRefFlags &target)
 class SAL_WARN_UNUSED ScAddress
 {
 private:
+    // Even if the fields are in the order "row, column, tab", in all (?) the ScAddress and
+    // ScDocument APIs that take separate row, column, and tab parameters, the parameters are in the
+    // order "column, row, tab", which matches the most common (A1) address syntax, if you ignore
+    // the sheet (tab). Don't let this confuse you, like it confused me for a while.
+
     SCROW   nRow;
     SCCOL   nCol;
     SCTAB   nTab;