[pango/misc-doc-fixups: 4/7] docs: Expand PangoTabArray docs




commit 6723792a086fe44cc615c1d1c98c4e2e70255494
Author: Matthias Clasen <mclasen redhat com>
Date:   Fri Dec 10 19:24:41 2021 -0500

    docs: Expand PangoTabArray docs

 pango/pango-tabs.c | 12 ++++++++----
 pango/pango-tabs.h |  6 +++---
 2 files changed, 11 insertions(+), 7 deletions(-)
---
diff --git a/pango/pango-tabs.c b/pango/pango-tabs.c
index 947b7e9b..bc8a7cb4 100644
--- a/pango/pango-tabs.c
+++ b/pango/pango-tabs.c
@@ -549,9 +549,11 @@ success:
  * @tab_index: the index of a tab stop
  * @decimal_point: the decimal point to use
  *
- * Sets the decimal point to use.
+ * Sets the Unicode character to use as decimal point.
  *
- * This is only relevant for %PANGO_TAB_DECIMAL.
+ * This is only relevant for tabs with %PANGO_TAB_DECIMAL alignment,
+ * which align content at the first occurrence of the decimal point
+ * character.
  *
  * By default, Pango uses the decimal point according
  * to the current locale.
@@ -577,9 +579,11 @@ pango_tab_array_set_decimal_point (PangoTabArray *tab_array,
  * @tab_array: a `PangoTabArray`
  * @tab_index: the index of a tab stop
  *
- * Gets the decimal point to use.
+ * Gets the Unicode character to use as decimal point.
  *
- * This is only relevant for %PANGO_TAB_DECIMAL.
+ * This is only relevant for tabs with %PANGO_TAB_DECIMAL alignment,
+ * which align content at the first occurrence of the decimal point
+ * character.
  *
  * The default value of 0 means that Pango will use the
  * decimal point according to the current locale.
diff --git a/pango/pango-tabs.h b/pango/pango-tabs.h
index a804977b..40837ba0 100644
--- a/pango/pango-tabs.h
+++ b/pango/pango-tabs.h
@@ -35,9 +35,9 @@ typedef struct _PangoTabArray PangoTabArray;
  *   until the available space is filled
  * @PANGO_TAB_CENTER: the text is centered at the tab stop position
  *   until the available space is filled
- * @PANGO_TAB_DECIMAL: text before the first '.' appears to the left of the
- *   tab stop position (until the available space is filled), the rest to
- *   the right
+ * @PANGO_TAB_DECIMAL: text before the first occurrence of the decimal point
+ *   character appears to the left of the tab stop position (until the available
+ *   space is filled), the rest to the right
  *
  * `PangoTabAlign` specifies where the text appears relative to the tab stop
  * position.


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]