Commit 2347ac3c authored by Matthias Clasen's avatar Matthias Clasen
Browse files

docs: Tweak script docs

Add summaries, convert markup, etc.
parent 50bd9eff
......@@ -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()
......
......@@ -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
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment