summaryrefslogtreecommitdiff
path: root/pango
diff options
context:
space:
mode:
Diffstat (limited to 'pango')
-rw-r--r--pango/pango-attributes.h5
1 files changed, 4 insertions, 1 deletions
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