summaryrefslogtreecommitdiff
path: root/pango/pango-coverage.h
diff options
context:
space:
mode:
authorMatthias Clasen <mclasen@redhat.com>2021-02-19 08:04:51 -0500
committerMatthias Clasen <mclasen@redhat.com>2021-03-11 13:17:36 -0500
commitd76d3e3270e826d96d9fff730e93e2b5cd53ca2c (patch)
tree10876780e58a23a88ac3af2d067ba95d89c1fbe2 /pango/pango-coverage.h
parent66106fc7819e5cbbdb6b5cf91e54f693f0c19410 (diff)
downloadpango-d76d3e3270e826d96d9fff730e93e2b5cd53ca2c.tar.gz
docs: Tweak coverage docs
Give doc comments summaries, remove section, etc.
Diffstat (limited to 'pango/pango-coverage.h')
-rw-r--r--pango/pango-coverage.h13
1 files changed, 9 insertions, 4 deletions
diff --git a/pango/pango-coverage.h b/pango/pango-coverage.h
index 7467dbda..67fc6306 100644
--- a/pango/pango-coverage.h
+++ b/pango/pango-coverage.h
@@ -32,8 +32,13 @@ G_BEGIN_DECLS
/**
* PangoCoverage:
*
- * The #PangoCoverage structure represents a map from Unicode characters
- * to #PangoCoverageLevel. It is an opaque structure with no public fields.
+ * A #PangoCoverage structure is a map from Unicode characters
+ * to #PangoCoverageLevel values.
+ *
+ * It is often necessary in Pango to determine if a particular font can
+ * represent a particular character, and also how well it can represent
+ * that character. The #PangoCoverage is a data structure that is used to
+ * represent that information. It is an opaque structure with no public fields.
*/
typedef struct _PangoCoverage PangoCoverage;
@@ -49,8 +54,8 @@ typedef struct _PangoCoverage PangoCoverage;
* the current script.
* @PANGO_COVERAGE_EXACT: The character is represented as the correct graphical form.
*
- * Used to indicate how well a font can represent a particular Unicode
- * character point for a particular script.
+ * `PangoCoverageLevel` is used to indicate how well a font can represent
+ * a particular Unicode character for a particular script.
*
* Since 1.44, only %PANGO_COVERAGE_NONE and %PANGO_COVERAGE_EXACT
* will be returned.