Skip to content

Commit 15344e4

Browse files
committed
Add doxygen for getTextBounds()
Signed-off-by: Emil Muratov <[email protected]>
1 parent 05df41d commit 15344e4

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

Adafruit_GFX.cpp

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1415,7 +1415,18 @@ void Adafruit_GFX::getTextBounds(const char *str, int16_t x, int16_t y,
14151415
}
14161416
}
14171417

1418-
// Overload for the same as above, but for String strings
1418+
/**************************************************************************/
1419+
/*!
1420+
@brief Helper to determine size of a string with current font/size. Pass string and a cursor position, returns UL corner and W,H.
1421+
@param str The ascii string to measure (as an arduino String() class)
1422+
@param x The current cursor X
1423+
@param y The current cursor Y
1424+
@param x1 The boundary X coordinate, set by function
1425+
@param y1 The boundary Y coordinate, set by function
1426+
@param w The boundary width, set by function
1427+
@param h The boundary height, set by function
1428+
*/
1429+
/**************************************************************************/
14191430
void Adafruit_GFX::getTextBounds(const String &str, int16_t x, int16_t y,
14201431
int16_t *x1, int16_t *y1, uint16_t *w, uint16_t *h) {
14211432
if (str.length() != 0) {

0 commit comments

Comments
 (0)