From e71fc7e4c37f4851ad3002afd256029e47fab5c4 Mon Sep 17 00:00:00 2001 From: Albrecht Schlosser Date: Tue, 10 Apr 2018 18:41:34 +0000 Subject: [PATCH] Document Fl_Rect::r() and b() to be outside the rectangle. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12825 ea41ed52-d2ee-0310-a9c1-e6b18d33e121 --- FL/Fl_Rect.H | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/FL/Fl_Rect.H b/FL/Fl_Rect.H index e3c61f720..00e570a82 100644 --- a/FL/Fl_Rect.H +++ b/FL/Fl_Rect.H @@ -3,7 +3,7 @@ // // Fl_Rect header file for the Fast Light Tool Kit (FLTK). // -// Copyright 1998-2017 by Bill Spitzak and others. +// Copyright 1998-2018 by Bill Spitzak and others. // // This library is free software. Distribution and use rights are outlined in // the file "COPYING" which should have been included with this file. If this @@ -65,8 +65,14 @@ public: int w() const { return w_; } ///< gets the width int h() const { return h_; } ///< gets the height - int r() const { return x_ + w_; } ///< gets the right edge (x + w) - int b() const { return y_ + h_; } ///< gets the bottom edge (y + h) + /** gets the right edge (x + w). + \note r() and b() are coordinates \b outside the area of the rectangle. + */ + int r() const { return x_ + w_; } + /** gets the bottom edge (y + h). + \note r() and b() are coordinates \b outside the area of the rectangle. + */ + int b() const { return y_ + h_; } void x(int X) { x_ = X; } ///< sets the x coordinate (left edge) void y(int Y) { y_ = Y; } ///< sets the y coordinate (top edge)