mirror of
https://gitlab.freedesktop.org/wlroots/wlroots.git
synced 2025-11-15 06:59:43 -05:00
Reformat doc comments
Unify the way we document our APIs. See CONTRIBUTING.md for the rules.
This commit is contained in:
parent
27383a1929
commit
28d89779af
65 changed files with 399 additions and 372 deletions
|
|
@ -31,16 +31,16 @@ struct wlr_buffer_resource_interface {
|
|||
/**
|
||||
* Initialize a buffer. This function should be called by producers. The
|
||||
* initialized buffer is referenced: once the producer is done with the buffer
|
||||
* they should call wlr_buffer_drop.
|
||||
* they should call wlr_buffer_drop().
|
||||
*/
|
||||
void wlr_buffer_init(struct wlr_buffer *buffer,
|
||||
const struct wlr_buffer_impl *impl, int width, int height);
|
||||
|
||||
/**
|
||||
* Allows the registration of a wl_resource implementation.
|
||||
* Allows the registration of a struct wl_resource implementation.
|
||||
*
|
||||
* The matching function will be called for the wl_resource when creating a
|
||||
* wlr_buffer from a wl_resource.
|
||||
* The matching function will be called for the struct wl_resource when creating
|
||||
* a struct wlr_buffer from a struct wl_resource.
|
||||
*/
|
||||
void wlr_buffer_register_resource_interface(
|
||||
const struct wlr_buffer_resource_interface *iface);
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@ void wlr_keyboard_init(struct wlr_keyboard *keyboard,
|
|||
const struct wlr_keyboard_impl *impl, const char *name);
|
||||
|
||||
/**
|
||||
* Cleans up all of the resources owned by wlr_keyboard.
|
||||
* Cleans up all of the resources owned by the struct wlr_keyboard.
|
||||
*/
|
||||
void wlr_keyboard_finish(struct wlr_keyboard *keyboard);
|
||||
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@
|
|||
WLR_OUTPUT_STATE_SUBPIXEL)
|
||||
|
||||
/**
|
||||
* A backend implementation of wlr_output.
|
||||
* A backend implementation of struct wlr_output.
|
||||
*
|
||||
* The commit function is mandatory. Other functions are optional.
|
||||
*/
|
||||
|
|
@ -39,7 +39,7 @@ struct wlr_output_impl {
|
|||
* The hotspot indicates the offset that needs to be applied to the
|
||||
* top-left corner of the image to match the cursor position. In other
|
||||
* words, the image should be displayed at (x - hotspot_x, y - hotspot_y).
|
||||
* The hotspot is given in the texture's coordinate space.
|
||||
* The hotspot is given in the buffer's coordinate space.
|
||||
*/
|
||||
bool (*set_cursor)(struct wlr_output *output, struct wlr_buffer *buffer,
|
||||
int hotspot_x, int hotspot_y);
|
||||
|
|
|
|||
|
|
@ -19,9 +19,11 @@ void wlr_tablet_pad_init(struct wlr_tablet_pad *pad,
|
|||
const struct wlr_tablet_pad_impl *impl, const char *name);
|
||||
|
||||
/**
|
||||
* Cleans up the resources owned by a wlr_tablet_pad.
|
||||
* This function will not clean the memory allocated by wlr_tablet_pad_group,
|
||||
* it's the responsibility of the caller to clean it.
|
||||
* Cleans up the resources owned by a struct wlr_tablet_pad.
|
||||
*
|
||||
* This function will not clean the memory allocated by
|
||||
* struct wlr_tablet_pad_group, it's the responsibility of the caller to clean
|
||||
* it.
|
||||
*/
|
||||
void wlr_tablet_pad_finish(struct wlr_tablet_pad *pad);
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue