[pango/gi-docs: 56/73] docs: Tweak script docs
- From: Matthias Clasen <matthiasc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [pango/gi-docs: 56/73] docs: Tweak script docs
- Date: Thu, 11 Mar 2021 19:32:42 +0000 (UTC)
commit 2347ac3c58ac694172b6888f79c97d1a9d42bb97
Author: Matthias Clasen <mclasen redhat com>
Date: Fri Feb 19 08:11:37 2021 -0500
docs: Tweak script docs
Add summaries, convert markup, etc.
pango/pango-script.c | 22 +++++++---------------
pango/pango-script.h | 7 ++++---
2 files changed, 11 insertions(+), 18 deletions(-)
---
diff --git a/pango/pango-script.c b/pango/pango-script.c
index 3ea42a89..7116a0a4 100644
--- a/pango/pango-script.c
+++ b/pango/pango-script.c
@@ -53,15 +53,6 @@
* of the copyright holder.
*/
-/**
- * SECTION:scripts
- * @short_description:Identifying writing systems and languages
- * @title:Scripts and Languages
- *
- * The functions in this section are used to identify the writing
- * system, or *script* of individual characters and of ranges within
- * a larger text string.
- */
#include "config.h"
#include <stdlib.h>
#include <string.h>
@@ -73,17 +64,18 @@
* pango_script_for_unichar:
* @ch: a Unicode character
*
- * Looks up the script for a particular character (as defined by
- * Unicode Standard Annex \#24). No check is made for @ch being a
- * valid Unicode character; if you pass in invalid character, the
- * result is undefined.
+ * Looks up the script for a particular character.
+ *
+ * The script of a character is defined by Unicode Standard Annex \#24.
+ * No check is made for @ch being a valid Unicode character; if you pass
+ * in invalid character, the result is undefined.
*
* Note that while the return type of this function is declared
- * as PangoScript, as of Pango 1.18, this function simply returns
+ * as `PangoScript`, as of Pango 1.18, this function simply returns
* the return value of g_unichar_get_script(). Callers must be
* prepared to handle unknown values.
*
- * Return value: the #PangoScript for the character.
+ * Return value: the `PangoScript` for the character.
*
* Since: 1.4
* Deprecated: 1.44. Use g_unichar_get_script()
diff --git a/pango/pango-script.h b/pango/pango-script.h
index 66cca15a..c1579982 100644
--- a/pango/pango-script.h
+++ b/pango/pango-script.h
@@ -29,7 +29,7 @@ G_BEGIN_DECLS
/**
* PangoScriptIter:
*
- * A #PangoScriptIter is used to iterate through a string
+ * A `PangoScriptIter` is used to iterate through a string
* and identify ranges in different scripts.
**/
typedef struct _PangoScriptIter PangoScriptIter;
@@ -157,8 +157,9 @@ typedef struct _PangoScriptIter PangoScriptIter;
* @PANGO_SCRIPT_SIGNWRITING: Signwriting. Since: 1.40
*
* The `PangoScript` enumeration identifies different writing
- * systems. The values correspond to the names as defined in the
- * Unicode standard. See
+ * systems.
+ *
+ * The values correspond to the names as defined in the Unicode standard. See
* [Unicode Standard Annex 24: Script names](http://www.unicode.org/reports/tr24/)
*
* Note that this enumeration is deprecated and will not be updated
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]