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

device: Add more doc annotations

Browse Source 
Even for internal API.
This commit is contained in:
Emmanuele Bassi 2011-01-19 13:54:27 +00:00
parent 50e52f550a
commit d3ed3d3a7b
1 changed files with 32 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
clutter/clutter-input-device.c
View File

@ -1002,6 +1002,18 @@ clutter_input_device_get_axis (ClutterInputDevice *device,
* Extracts the value of the given @axis of a #ClutterInputDevice from * Extracts the value of the given @axis of a #ClutterInputDevice from
* an array of axis values. * an array of axis values.
* *
* An example of typical usage for this function is:
*
* |[
* ClutterInputDevice *device = clutter_event_get_device (event);
* gdouble *axes = clutter_event_get_axes (event, NULL);
* gdouble pressure_value = 0;
*
* clutter_input_device_get_axis_value (device, axes,
* CLUTTER_INPUT_AXIS_PRESSURE,
* &pressure_value);
* ]|
*
* Return value: %TRUE if the value was set, and %FALSE otherwise * Return value: %TRUE if the value was set, and %FALSE otherwise
* *
* Since: 1.6 * Since: 1.6
@ -1167,6 +1179,16 @@ clutter_input_device_get_key (ClutterInputDevice *device,
return TRUE; return TRUE;
} }
/*< private >
* clutter_input_device_add_slave:
* @master: a #ClutterInputDevice
* @slave: a #ClutterInputDevice
*
* Adds @slave to the list of slave devices of @master
*
* This function does not increase the reference count of either @master
* or @slave.
*/
void void
_clutter_input_device_add_slave (ClutterInputDevice *master, _clutter_input_device_add_slave (ClutterInputDevice *master,
ClutterInputDevice *slave) ClutterInputDevice *slave)
@ -1175,6 +1197,16 @@ _clutter_input_device_add_slave (ClutterInputDevice *master,
master->slaves = g_list_prepend (master->slaves, slave); master->slaves = g_list_prepend (master->slaves, slave);
} }
/*< private >
* clutter_input_device_remove_slave:
* @master: a #ClutterInputDevice
* @slave: a #ClutterInputDevice
*
* Removes @slave from the list of slave devices of @master.
*
* This function does not decrease the reference count of either @master
* or @slave.
*/
void void
_clutter_input_device_remove_slave (ClutterInputDevice *master, _clutter_input_device_remove_slave (ClutterInputDevice *master,
ClutterInputDevice *slave) ClutterInputDevice *slave)