[pango/matthiasc/for-master: 202/202] Expand the PANGO_UNDERLINE_ERROR docs
- From: Matthias Clasen <matthiasc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [pango/matthiasc/for-master: 202/202] Expand the PANGO_UNDERLINE_ERROR docs
- Date: Sat, 3 Apr 2021 18:09:29 +0000 (UTC)
commit 0db2d63ba5a77eabb17f7fedceb48ef5a36c7805
Author: Matthias Clasen <mclasen redhat com>
Date: Sat Apr 3 14:08:26 2021 -0400
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(-)
---
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
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]