summaryrefslogtreecommitdiff
path: root/pango/pango-attributes.h
diff options
context:
space:
mode:
authorMatthias Clasen <mclasen@redhat.com>2021-04-03 14:08:26 -0400
committerMatthias Clasen <mclasen@redhat.com>2021-04-03 14:08:26 -0400
commit0db2d63ba5a77eabb17f7fedceb48ef5a36c7805 (patch)
treebade88d451a50490928eb20248a94ea80d494a78 /pango/pango-attributes.h
parentb83e3ba78ea3466c001b465e9f0620c7ef5d7a5a (diff)
downloadpango-0db2d63ba5a77eabb17f7fedceb48ef5a36c7805.tar.gz
Expand the PANGO_UNDERLINE_ERROR docs
Clarify that the exact style of rendering is up to the PangoRenderer in use.
Diffstat (limited to 'pango/pango-attributes.h')
-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