From 28d89779af6de0340533b2674a98ab6ecc238599 Mon Sep 17 00:00:00 2001 From: Simon Ser Date: Tue, 24 May 2022 18:46:59 +0200 Subject: Reformat doc comments Unify the way we document our APIs. See CONTRIBUTING.md for the rules. --- include/wlr/render/allocator.h | 4 ++-- include/wlr/render/drm_format_set.h | 2 +- include/wlr/render/egl.h | 2 +- include/wlr/render/wlr_renderer.h | 12 +++++++----- include/wlr/render/wlr_texture.h | 2 +- 5 files changed, 12 insertions(+), 10 deletions(-) (limited to 'include/wlr/render') diff --git a/include/wlr/render/allocator.h b/include/wlr/render/allocator.h index 3150e36c..f5bb7522 100644 --- a/include/wlr/render/allocator.h +++ b/include/wlr/render/allocator.h @@ -37,7 +37,7 @@ struct wlr_allocator { }; /** - * Creates the adequate wlr_allocator given a backend and a renderer + * Creates the adequate struct wlr_allocator given a backend and a renderer. */ struct wlr_allocator *wlr_allocator_autocreate(struct wlr_backend *backend, struct wlr_renderer *renderer); @@ -50,7 +50,7 @@ void wlr_allocator_destroy(struct wlr_allocator *alloc); * Allocate a new buffer. * * When the caller is done with it, they must unreference it by calling - * wlr_buffer_drop. + * wlr_buffer_drop(). * * The `format` passed in indicates the format to use and the list of * acceptable modifiers. The order in which modifiers are listed is not diff --git a/include/wlr/render/drm_format_set.h b/include/wlr/render/drm_format_set.h index 9f4a86ea..6dbdc749 100644 --- a/include/wlr/render/drm_format_set.h +++ b/include/wlr/render/drm_format_set.h @@ -51,7 +51,7 @@ struct wlr_drm_format_set { void wlr_drm_format_set_finish(struct wlr_drm_format_set *set); /** - * Return a pointer to a member of this `wlr_drm_format_set` of format + * Return a pointer to a member of this struct wlr_drm_format_set of format * `format`, or NULL if none exists. */ const struct wlr_drm_format *wlr_drm_format_set_get( diff --git a/include/wlr/render/egl.h b/include/wlr/render/egl.h index 0d84958b..e4416e0b 100644 --- a/include/wlr/render/egl.h +++ b/include/wlr/render/egl.h @@ -77,7 +77,7 @@ struct wlr_egl *wlr_egl_create_with_context(EGLDisplay display, * Make the EGL context current. * * Callers are expected to clear the current context when they are done by - * calling wlr_egl_unset_current. + * calling wlr_egl_unset_current(). */ bool wlr_egl_make_current(struct wlr_egl *egl); diff --git a/include/wlr/render/wlr_renderer.h b/include/wlr/render/wlr_renderer.h index d8b04dc7..50ba6b21 100644 --- a/include/wlr/render/wlr_renderer.h +++ b/include/wlr/render/wlr_renderer.h @@ -77,13 +77,13 @@ void wlr_render_quad_with_matrix(struct wlr_renderer *r, const float color[static 4], const float matrix[static 9]); /** * Get the shared-memory formats supporting import usage. Buffers allocated - * with a format from this list may be imported via wlr_texture_from_pixels. + * with a format from this list may be imported via wlr_texture_from_pixels(). */ const uint32_t *wlr_renderer_get_shm_texture_formats( struct wlr_renderer *r, size_t *len); /** * Get the DMA-BUF formats supporting sampling usage. Buffers allocated with - * a format from this list may be imported via wlr_texture_from_dmabuf. + * a format from this list may be imported via wlr_texture_from_dmabuf(). */ const struct wlr_drm_format_set *wlr_renderer_get_dmabuf_texture_formats( struct wlr_renderer *renderer); @@ -92,7 +92,7 @@ const struct wlr_drm_format_set *wlr_renderer_get_dmabuf_texture_formats( * bytes. * * If `flags` is not NULl, the caller indicates that it accepts frame flags - * defined in `enum wlr_renderer_read_pixels_flags`. + * defined in enum wlr_renderer_read_pixels_flags. */ bool wlr_renderer_read_pixels(struct wlr_renderer *r, uint32_t fmt, uint32_t *flags, uint32_t stride, uint32_t width, uint32_t height, @@ -107,7 +107,7 @@ bool wlr_renderer_init_wl_display(struct wlr_renderer *r, struct wl_display *wl_display); /** - * Initializes wl_shm on the provided wl_display. + * Initializes wl_shm on the provided struct wl_display. */ bool wlr_renderer_init_wl_shm(struct wlr_renderer *r, struct wl_display *wl_display); @@ -120,7 +120,9 @@ bool wlr_renderer_init_wl_shm(struct wlr_renderer *r, int wlr_renderer_get_drm_fd(struct wlr_renderer *r); /** - * Destroys this wlr_renderer. Textures must be destroyed separately. + * Destroys the renderer. + * + * Textures must be destroyed separately. */ void wlr_renderer_destroy(struct wlr_renderer *renderer); diff --git a/include/wlr/render/wlr_texture.h b/include/wlr/render/wlr_texture.h index 90bb5de5..93fc221c 100644 --- a/include/wlr/render/wlr_texture.h +++ b/include/wlr/render/wlr_texture.h @@ -51,7 +51,7 @@ bool wlr_texture_write_pixels(struct wlr_texture *texture, const void *data); /** - * Destroys this wlr_texture. + * Destroys the texture. */ void wlr_texture_destroy(struct wlr_texture *texture); -- cgit v1.2.3