From 0db2d63ba5a77eabb17f7fedceb48ef5a36c7805 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Sat, 3 Apr 2021 14:08:26 -0400 Subject: Expand the PANGO_UNDERLINE_ERROR docs Clarify that the exact style of rendering is up to the PangoRenderer in use. --- pango/pango-attributes.h | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) (limited to 'pango') diff --git a/pango/pango-attributes.h b/pango/pango-attributes.h index e20b6413..db8d8262 100644 --- a/pango/pango-attributes.h +++ b/pango/pango-attributes.h @@ -214,7 +214,10 @@ typedef enum * single characters, such as for keyboard accelerators. * %PANGO_UNDERLINE_SINGLE should be used for extended * portions of text. - * @PANGO_UNDERLINE_ERROR: a wavy underline should be drawn below. + * @PANGO_UNDERLINE_ERROR: an underline indicating an error should + * be drawn below. The exact style of rendering is up to the + * `PangoRenderer` in use, but typical styles include wavy + * or dotted lines. * This underline is typically used to indicate an error such * as a possible mispelling; in some cases a contrasting color * may automatically be used. This type of underlining is -- cgit v1.2.1