isa/mutter
1
0
Fork 0
mirror of https://github.com/brl/mutter.git synced 2024-12-23 19:42:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Port backend-specific sections to markdown

Browse Source
This commit is contained in:
Emmanuele Bassi 2014-03-17 23:10:07 +00:00
parent 46051bfb20
commit ddc1955f6b
5 changed files with 12 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
clutter/cex100/clutter-backend-cex100.c
View File

@ -142,7 +142,7 @@ clutter_backend_cex100_init (ClutterBackendCex100 *backend_cex100)
* the stage will be drawn. By default Clutter will pick UPP_C * the stage will be drawn. By default Clutter will pick UPP_C
* (GDL_PLANE_ID_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 * Since: 1.6
*/ */
@ -164,7 +164,7 @@ clutter_cex100_set_plane (gdl_plane_id_t plane)
* *
* Clutter defaults to %CLUTTER_CEX100_TRIPLE_BUFFERING. * 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 * Since: 1.6
*/ */

3
clutter/cex100/clutter-cex100.h.in
View File

@ -29,8 +29,7 @@
* The CEX100 backend for Clutter provides some Intel CE3100/CE4100 * The CEX100 backend for Clutter provides some Intel CE3100/CE4100
* specific API * specific API
* *
* You need to include * You need to include `clutter/cex100/clutter-cex100.h`
* <filename class="headerfile">&lt;clutter/cex100/clutter-cex100.h&gt;</filename>
* to have access to the functions documented here. * to have access to the functions documented here.
*/ */

4
clutter/egl/clutter-egl.h
View File

@ -29,9 +29,7 @@
* *
* The EGL backend for Clutter provides some EGL specific API * The EGL backend for Clutter provides some EGL specific API
* *
* You need to include * You need to include `clutter-egl.h` to have access to the functions documented here.
* <filename class="headerfile">&lt;clutter/egl/clutter-egl.h&gt;</filename>
* to have access to the functions documented here.
*/ */
#ifndef __CLUTTER_EGL_H__ #ifndef __CLUTTER_EGL_H__

3
clutter/wayland/clutter-backend-wayland.c
View File

@ -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 * event dispatch; in general only a single source should be acting on changes
* on the Wayland file descriptor. * on the Wayland file descriptor.
* *
* <warning>This function can only be called before calling * This function can only be called before calling clutter_init().
* clutter_init().</warning>
* *
* This function should not be normally used by applications. * This function should not be normally used by applications.
* *

15
clutter/x11/clutter-backend-x11.c
View File

@ -949,15 +949,14 @@ clutter_x11_enable_xinput (void)
* You also must call clutter_x11_handle_event() to let Clutter process * You also must call clutter_x11_handle_event() to let Clutter process
* events and maintain its internal state. * events and maintain its internal state.
* *
* <warning>This function can only be called before calling * This function can only be called before calling clutter_init().
* clutter_init().</warning>
* *
* <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 * all the events required to maintain its internal state on the stage
* Window; compositors using Clutter and input regions to pass events * Window; compositors using Clutter and input regions to pass events
* through to application windows should not rely on an empty input * through to application windows should not rely on an empty input
* region, and should instead clear it themselves explicitly using the * region, and should instead clear it themselves explicitly using the
* XFixes extension.</note> * XFixes extension.
* *
* This function should not be normally used by applications. * 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. * By default, Clutter requests RGB visuals.
* *
* <note>If no ARGB visuals are found, the X11 backend will fall back to * If no ARGB visuals are found, the X11 backend will fall back to
* requesting a RGB visual instead.</note> * requesting a RGB visual instead.
* *
* ARGB visuals are required for the #ClutterStage:use-alpha property to work. * 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 * This function can only be called once, and before clutter_init() is
* called.</note> * called.
* *
* Since: 1.2 * Since: 1.2
*/ */