summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--include/tools/gen.hxx9
1 files changed, 9 insertions, 0 deletions
diff --git a/include/tools/gen.hxx b/include/tools/gen.hxx
index 142f82cbd6b8..bebc35015e82 100644
--- a/include/tools/gen.hxx
+++ b/include/tools/gen.hxx
@@ -330,6 +330,15 @@ inline std::basic_ostream<charT, traits> & operator <<(
#define RECT_MAX LONG_MAX
#define RECT_MIN LONG_MIN
+/// Note: this class is a true marvel of engineering: because the author
+/// could not decide whether it's better to have a closed or half-open
+/// interval, they just implemented *both* in the same class!
+///
+/// If you have the misfortune of having to use this class, don't immediately
+/// despair but first take note that the uppercase GetWidth() / GetHeight()
+/// etc. methods interpret the interval as closed, while the lowercase
+/// getWidth() / getHeight() etc. methods interpret the interval as half-open.
+/// Ok, now is the time for despair.
class SAL_WARN_UNUSED TOOLS_DLLPUBLIC Rectangle
{
public: