mir/libreoffice
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

tools: document our favorite rectangle class too

Browse Source 
Change-Id: Id7698a1e2a8fc1ca6bf35868311fc5b284d45145
This commit is contained in:
Michael Stahl
2016-12-06 22:49:09 +01:00
parent 9fb1919a65
commit c43fdd0d17
1 changed files with 9 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
include/tools/gen.hxx
View File

@@ -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: