summaryrefslogtreecommitdiff
path: root/pango/pango-script.c
diff options
context:
space:
mode:
authorMatthias Clasen <mclasen@redhat.com>2021-05-19 16:06:44 -0400
committerMatthias Clasen <mclasen@redhat.com>2021-05-19 16:34:05 -0400
commit7f04ed9259fd91cdb3dc61c5aa43d196ec6a965f (patch)
tree51fdf2d97b85ef4a3e7c870389b92130c9b1a491 /pango/pango-script.c
parent75eee838a91bad404d211b002f26e9af3033f0d5 (diff)
downloadpango-7f04ed9259fd91cdb3dc61c5aa43d196ec6a965f.tar.gz
docs: Convert gtk-doc syntax leftoversdocs-cleanup
Remove leftovers like #Type, reduce indentations to avoid markdown block quotes, etc.
Diffstat (limited to 'pango/pango-script.c')
-rw-r--r--pango/pango-script.c43
1 files changed, 23 insertions, 20 deletions
diff --git a/pango/pango-script.c b/pango/pango-script.c
index f201b3aa..fc7c6332 100644
--- a/pango/pango-script.c
+++ b/pango/pango-script.c
@@ -122,14 +122,16 @@ _pango_script_iter_init (PangoScriptIter *iter,
* @text: a UTF-8 string
* @length: length of @text, or -1 if @text is nul-terminated.
*
- * Create a new #PangoScriptIter, used to break a string of
- * Unicode text into runs by Unicode script. No copy is made of
- * @text, so the caller needs to make sure it remains valid until
- * the iterator is freed with pango_script_iter_free().
+ * Create a new `PangoScriptIter`, used to break a string of
+ * Unicode text into runs by Unicode script.
+ *
+ * No copy is made of @text, so the caller needs to make
+ * sure it remains valid until the iterator is freed with
+ * [method@Pango.ScriptIter.free].
*
* Return value: the new script iterator, initialized
* to point at the first range in the text, which should be
- * freed with pango_script_iter_free(). If the string is
+ * freed with [method@Pango.ScriptIter.free]. If the string is
* empty, it will point at an empty range.
*
* Since: 1.4
@@ -154,12 +156,12 @@ _pango_script_iter_fini (PangoScriptIter *iter)
/**
* pango_script_iter_free:
- * @iter: a #PangoScriptIter
+ * @iter: a `PangoScriptIter`
*
- * Frees a #PangoScriptIter created with pango_script_iter_new().
+ * Frees a `PangoScriptIter`.
*
* Since: 1.4
- **/
+ */
void
pango_script_iter_free (PangoScriptIter *iter)
{
@@ -169,22 +171,22 @@ pango_script_iter_free (PangoScriptIter *iter)
/**
* pango_script_iter_get_range:
- * @iter: a #PangoScriptIter
- * @start: (out) (optional): location to store start position of the range, or %NULL
- * @end: (out) (optional): location to store end position of the range, or %NULL
- * @script: (out) (optional): location to store script for range, or %NULL
+ * @iter: a `PangoScriptIter`
+ * @start: (out) (optional): location to store start position of the range
+ * @end: (out) (optional): location to store end position of the range
+ * @script: (out) (optional): location to store script for range
*
* Gets information about the range to which @iter currently points.
* The range is the set of locations p where *start <= p < *end.
* (That is, it doesn't include the character stored at *end)
*
* Note that while the type of the @script argument is declared
- * as PangoScript, as of Pango 1.18, this function simply returns
+ * as `PangoScript`, as of Pango 1.18, this function simply returns
* GUnicodeScript values. Callers must be prepared to handle unknown
* values.
*
* Since: 1.4
- **/
+ */
void
pango_script_iter_get_range (PangoScriptIter *iter,
const char **start,
@@ -292,16 +294,17 @@ get_pair_index (gunichar ch)
/**
* pango_script_iter_next:
- * @iter: a #PangoScriptIter
+ * @iter: a `PangoScriptIter`
+ *
+ * Advances a `PangoScriptIter` to the next range.
*
- * Advances a #PangoScriptIter to the next range. If @iter
- * is already at the end, it is left unchanged and %FALSE
- * is returned.
+ * If @iter is already at the end, it is left unchanged
+ * and %FALSE is returned.
*
- * Return value: %TRUE if @iter was successfully advanced.
+ * Return value: %TRUE if @iter was successfully advanced
*
* Since: 1.4
- **/
+ */
gboolean
pango_script_iter_next (PangoScriptIter *iter)
{