[clutter/clutter-1.18] docs: Port backend-specific sections to markdown



commit ddc1955f6b5bfe4d7785d38e391380a992395011
Author: Emmanuele Bassi <ebassi gnome org>
Date:   Mon Mar 17 23:10:07 2014 +0000

    docs: Port backend-specific sections to markdown

 clutter/cex100/clutter-backend-cex100.c   |    4 ++--
 clutter/cex100/clutter-cex100.h.in        |    3 +--
 clutter/egl/clutter-egl.h                 |    4 +---
 clutter/wayland/clutter-backend-wayland.c |    3 +--
 clutter/x11/clutter-backend-x11.c         |   15 +++++++--------
 5 files changed, 12 insertions(+), 17 deletions(-)
---
diff --git a/clutter/cex100/clutter-backend-cex100.c b/clutter/cex100/clutter-backend-cex100.c
index 264dc00..4bd498f 100644
--- a/clutter/cex100/clutter-backend-cex100.c
+++ b/clutter/cex100/clutter-backend-cex100.c
@@ -142,7 +142,7 @@ clutter_backend_cex100_init (ClutterBackendCex100 *backend_cex100)
  * the stage will be drawn. By default Clutter will pick UPP_C
  * (GDL_PLANE_ID_UPP_C).
  *
- * <note>This function has to be called before clutter_init()</note>
+ * This function has to be called before clutter_init().
  *
  * Since: 1.6
  */
@@ -164,7 +164,7 @@ clutter_cex100_set_plane (gdl_plane_id_t plane)
  *
  * Clutter defaults to %CLUTTER_CEX100_TRIPLE_BUFFERING.
  *
- * <note>This function has to be called before clutter_init()</note>
+ * This function has to be called before clutter_init().
  *
  * Since: 1.6
  */
diff --git a/clutter/cex100/clutter-cex100.h.in b/clutter/cex100/clutter-cex100.h.in
index 57e241d..c1ea011 100644
--- a/clutter/cex100/clutter-cex100.h.in
+++ b/clutter/cex100/clutter-cex100.h.in
@@ -29,8 +29,7 @@
  * The CEX100 backend for Clutter provides some Intel CE3100/CE4100
  * specific API
  *
- * You need to include
- * <filename class="headerfile">&lt;clutter/cex100/clutter-cex100.h&gt;</filename>
+ * You need to include `clutter/cex100/clutter-cex100.h`
  * to have access to the functions documented here.
  */
 
diff --git a/clutter/egl/clutter-egl.h b/clutter/egl/clutter-egl.h
index b25b1be..f57a4c1 100644
--- a/clutter/egl/clutter-egl.h
+++ b/clutter/egl/clutter-egl.h
@@ -29,9 +29,7 @@
  *
  * The EGL backend for Clutter provides some EGL specific API
  *
- * You need to include
- * <filename class="headerfile">&lt;clutter/egl/clutter-egl.h&gt;</filename>
- * to have access to the functions documented here.
+ * You need to include `clutter-egl.h` to have access to the functions documented here.
  */
 
 #ifndef __CLUTTER_EGL_H__
diff --git a/clutter/wayland/clutter-backend-wayland.c b/clutter/wayland/clutter-backend-wayland.c
index aa3bc7b..dcc7c65 100644
--- a/clutter/wayland/clutter-backend-wayland.c
+++ b/clutter/wayland/clutter-backend-wayland.c
@@ -359,8 +359,7 @@ clutter_wayland_set_display (struct wl_display *display)
  * event dispatch; in general only a single source should be acting on changes
  * on the Wayland file descriptor.
  *
- * <warning>This function can only be called before calling
- * clutter_init().</warning>
+ * This function can only be called before calling clutter_init().
  *
  * This function should not be normally used by applications.
  *
diff --git a/clutter/x11/clutter-backend-x11.c b/clutter/x11/clutter-backend-x11.c
index 54845cb..5e5d506 100644
--- a/clutter/x11/clutter-backend-x11.c
+++ b/clutter/x11/clutter-backend-x11.c
@@ -949,15 +949,14 @@ clutter_x11_enable_xinput (void)
  * You also must call clutter_x11_handle_event() to let Clutter process
  * events and maintain its internal state.
  *
- * <warning>This function can only be called before calling
- * clutter_init().</warning>
+ * This function can only be called before calling clutter_init().
  *
- * <note>Even with event handling disabled, Clutter will still select
+ * Even with event handling disabled, Clutter will still select
  * all the events required to maintain its internal state on the stage
  * Window; compositors using Clutter and input regions to pass events
  * through to application windows should not rely on an empty input
  * region, and should instead clear it themselves explicitly using the
- * XFixes extension.</note>
+ * XFixes extension.
  *
  * This function should not be normally used by applications.
  *
@@ -1262,13 +1261,13 @@ clutter_x11_has_composite_extension (void)
  *
  * By default, Clutter requests RGB visuals.
  *
- * <note>If no ARGB visuals are found, the X11 backend will fall back to
- * requesting a RGB visual instead.</note>
+ * If no ARGB visuals are found, the X11 backend will fall back to
+ * requesting a RGB visual instead.
  *
  * ARGB visuals are required for the #ClutterStage:use-alpha property to work.
  *
- * <note>This function can only be called once, and before clutter_init() is
- * called.</note>
+ * This function can only be called once, and before clutter_init() is
+ * called.
  *
  * Since: 1.2
  */


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]