[clutter] docs: Remove leftover DocBook tags
- From: Emmanuele Bassi <ebassi src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [clutter] docs: Remove leftover DocBook tags
- Date: Thu, 12 Mar 2015 20:58:06 +0000 (UTC)
commit 1912f28063390c06aabeacc5e0634e8f2a52a23d
Author: Emmanuele Bassi <ebassi gnome org>
Date: Wed Mar 11 15:39:42 2015 +0000
docs: Remove leftover DocBook tags
We use markdown for the documentation.
clutter/clutter-color.c | 7 +++----
clutter/clutter-main.c | 2 +-
clutter/clutter-paint-node.c | 7 +++----
clutter/clutter-paint-nodes.c | 10 +++++-----
clutter/clutter-script.c | 5 ++---
clutter/clutter-settings.c | 2 +-
clutter/x11/clutter-backend-x11.c | 8 +++-----
7 files changed, 18 insertions(+), 23 deletions(-)
---
diff --git a/clutter/clutter-color.c b/clutter/clutter-color.c
index 7fb4192..b855184 100644
--- a/clutter/clutter-color.c
+++ b/clutter/clutter-color.c
@@ -615,10 +615,9 @@ parse_hsla (ClutterColor *color,
* @color: (out caller-allocates): return location for a #ClutterColor
* @str: a string specifiying a color
*
- * Parses a string definition of a color, filling the
- * <structfield>red</structfield>, <structfield>green</structfield>,
- * <structfield>blue</structfield> and <structfield>alpha</structfield>
- * channels of @color.
+ * Parses a string definition of a color, filling the #ClutterColor.red,
+ * #ClutterColor.green, #ClutterColor.blue and #ClutterColor.alpha fields
+ * of @color.
*
* The @color is not allocated.
*
diff --git a/clutter/clutter-main.c b/clutter/clutter-main.c
index 7b1a615..5fc12c9 100644
--- a/clutter/clutter-main.c
+++ b/clutter/clutter-main.c
@@ -3480,7 +3480,7 @@ clutter_check_version (guint major,
* clutter_get_default_text_direction:
*
* Retrieves the default direction for the text. The text direction is
- * determined by the locale and/or by the <varname>CLUTTER_TEXT_DIRECTION</varname>
+ * determined by the locale and/or by the `CLUTTER_TEXT_DIRECTION`
* environment variable.
*
* The default text direction can be overridden on a per-actor basis by using
diff --git a/clutter/clutter-paint-node.c b/clutter/clutter-paint-node.c
index 04fe081..1e5a3b7 100644
--- a/clutter/clutter-paint-node.c
+++ b/clutter/clutter-paint-node.c
@@ -44,8 +44,8 @@
/**
* ClutterPaintNode: (ref-func clutter_paint_node_ref) (unref-func clutter_paint_node_unref) (set-value-func
clutter_value_set_paint_node) (get-value-func clutter_value_get_paint_node)
*
- * The <structname>ClutterPaintNode</structname> structure contains only
- * private data and it should be accessed using the provided API.
+ * The `ClutterPaintNode` structure contains only private data
+ * and it should be accessed using the provided API.
*
* Since: 1.10
*/
@@ -53,8 +53,7 @@
/**
* ClutterPaintNodeClass:
*
- * The <structname>ClutterPaintNodeClass</structname> structure contains
- * only private data.
+ * The `ClutterPaintNodeClass` structure contains only private data.
*
* Since: 1.10
*/
diff --git a/clutter/clutter-paint-nodes.c b/clutter/clutter-paint-nodes.c
index acb87e5..4823138 100644
--- a/clutter/clutter-paint-nodes.c
+++ b/clutter/clutter-paint-nodes.c
@@ -358,7 +358,7 @@ struct _ClutterPipelineNode
/**
* ClutterPipelineNodeClass:
*
- * The <structname>ClutterPipelineNodeClass</structname> structure is an opaque
+ * The `ClutterPipelineNodeClass` structure is an opaque
* type whose members cannot be directly accessed.
*
* Since: 1.10
@@ -552,7 +552,7 @@ struct _ClutterColorNode
/**
* ClutterColorNodeClass:
*
- * The <structname>ClutterColorNodeClass</structname> structure is an
+ * The `ClutterColorNodeClass` structure is an
* opaque type whose members cannot be directly accessed.
*
* Since: 1.10
@@ -627,7 +627,7 @@ struct _ClutterTextureNode
/**
* ClutterTextureNodeClass:
*
- * The <structname>ClutterTextureNodeClass</structname> structure is an
+ * The `ClutterTextureNodeClass` structure is an
* opaque type whose members cannot be directly accessed.
*
* Since: 1.10
@@ -744,7 +744,7 @@ struct _ClutterTextNode
/**
* ClutterTextNodeClass:
*
- * The <structname>ClutterTextNodeClass</structname> structure is an opaque
+ * The `ClutterTextNodeClass` structure is an opaque
* type whose contents cannot be directly accessed.
*
* Since: 1.10
@@ -948,7 +948,7 @@ struct _ClutterClipNode
/**
* ClutterClipNodeClass:
*
- * The <structname>ClutterClipNodeClass</structname> structure is an opaque
+ * The `ClutterClipNodeClass` structure is an opaque
* type whose members cannot be directly accessed.
*
* Since: 1.10
diff --git a/clutter/clutter-script.c b/clutter/clutter-script.c
index b38857e..cd58e9d 100644
--- a/clutter/clutter-script.c
+++ b/clutter/clutter-script.c
@@ -130,9 +130,8 @@
* ]]></programlisting></informalexample>
*
* Implicitely defined #ClutterAlpha<!-- -->s and #ClutterTimeline<!-- -->s
- * can omit the <varname>id</varname> member, as well as the
- * <varname>type</varname> member, but will not be available using
- * clutter_script_get_object() (they can, however, be extracted using the
+ * can omit the `id`, as well as the `type` members, but will not be available
+ * using clutter_script_get_object() (they can, however, be extracted using the
* #ClutterBehaviour and #ClutterAlpha API respectively).
*
* Signal handlers can be defined inside a Clutter UI definition file and
diff --git a/clutter/clutter-settings.c b/clutter/clutter-settings.c
index a269c3a..0bdfdcb 100644
--- a/clutter/clutter-settings.c
+++ b/clutter/clutter-settings.c
@@ -43,7 +43,7 @@
/**
* ClutterSettings:
*
- * <structname>ClutterSettings</structname> is an opaque structure whose
+ * `ClutterSettings` is an opaque structure whose
* members cannot be directly accessed.
*
* Since: 1.4
diff --git a/clutter/x11/clutter-backend-x11.c b/clutter/x11/clutter-backend-x11.c
index 13662ed..243c73e 100644
--- a/clutter/x11/clutter-backend-x11.c
+++ b/clutter/x11/clutter-backend-x11.c
@@ -1402,12 +1402,10 @@ _clutter_backend_x11_get_visual_info (ClutterBackendX11 *backend_x11)
/**
* clutter_x11_get_visual_info: (skip)
*
- * Retrieves the <structname>XVisualInfo</structname> used by the Clutter X11
- * backend.
+ * Retrieves the `XVisualInfo` used by the Clutter X11 backend.
*
- * Return value: (transfer full): a <structname>XVisualInfo</structname>, or
- * <varname>None</varname>. The returned value should be freed using XFree()
- * when done
+ * Return value: (transfer full): a `XVisualInfo`, or `None`.
+ * The returned value should be freed using `XFree()` when done
*
* Since: 1.2
*/
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]