From b6660b99d61c1e45af91b577f023815c52da173d Mon Sep 17 00:00:00 2001 From: Kbz-8 Date: Tue, 17 Dec 2024 03:00:12 +0100 Subject: [PATCH] fixing documentation in headers --- includes/mlx.h | 10 +++++----- includes/mlx_extended.h | 7 ++++--- 2 files changed, 9 insertions(+), 8 deletions(-) diff --git a/includes/mlx.h b/includes/mlx.h index 56f461e..29babe4 100644 --- a/includes/mlx.h +++ b/includes/mlx.h @@ -6,7 +6,7 @@ /* By: maldavid +#+ +:+ +#+ */ /* +#+#+#+#+#+ +#+ */ /* Created: 2022/10/04 16:56:35 by maldavid #+# #+# */ -/* Updated: 2024/12/17 02:23:40 by maldavid ### ########.fr */ +/* Updated: 2024/12/17 02:58:07 by maldavid ### ########.fr */ /* */ /* ************************************************************************** */ @@ -207,7 +207,7 @@ MLX_API void mlx_get_screen_size(mlx_context mlx, mlx_window win, int* w, int* h /** - * @brief Gives a function to be executed at each loop turn + * @brief Gives another function to be executed at each loop turn * * @param mlx Internal MLX application * @param f The function @@ -281,7 +281,7 @@ typedef enum mlx_event_type } mlx_event_type; /** - * @brief Gives a function to be executed on event type + * @brief Gives a function to be executed on event type, does not override previous functions * * @param mlx Internal MLX application * @param win Internal window @@ -303,7 +303,7 @@ MLX_API void mlx_on_event(mlx_context mlx, mlx_window win, mlx_event_type event, * @param win Internal window * @param x X coordinate * @param y Y coordinate - * @param color Color of the pixel (coded on 4 bytes in an int, 0xRRGGBBAA) + * @param color Color of the pixel */ MLX_API void mlx_pixel_put(mlx_context mlx, mlx_window win, int x, int y, mlx_color color); @@ -405,7 +405,7 @@ MLX_API void mlx_put_image_to_window(mlx_context mlx, mlx_window win, mlx_image * @param win Internal window * @param x X coordinate * @param y Y coordinate - * @param color Color of the pixel (coded on 4 bytes in an int, 0xAARRGGBB) + * @param color Color of the pixel * @param str Text to put */ MLX_API void mlx_string_put(mlx_context mlx, mlx_window win, int x, int y, mlx_color color, char* str); diff --git a/includes/mlx_extended.h b/includes/mlx_extended.h index a67206f..12bbea0 100644 --- a/includes/mlx_extended.h +++ b/includes/mlx_extended.h @@ -6,7 +6,7 @@ /* By: maldavid +#+ +:+ +#+ */ /* +#+#+#+#+#+ +#+ */ /* Created: 2024/12/14 16:17:10 by maldavid #+# #+# */ -/* Updated: 2024/12/16 20:33:50 by maldavid ### ########.fr */ +/* Updated: 2024/12/17 02:59:50 by maldavid ### ########.fr */ /* */ /* ************************************************************************** */ @@ -83,7 +83,8 @@ MLX_API void mlx_restore_window(mlx_context mlx, mlx_window win); * @param win Internal window * @param x X coordinate * @param y Y coordinate - * @param pixels Array of pixels (coded on 4 bytes in an int, 0xRRGGBBAA) + * @param pixels Array of pixels + * @param pixels_size Size or the array of pixels */ MLX_API void mlx_pixel_put_array(mlx_context mlx, mlx_window win, int x, int y, mlx_color* pixels, size_t pixels_size); @@ -96,7 +97,7 @@ MLX_API void mlx_pixel_put_array(mlx_context mlx, mlx_window win, int x, int y, * @param y Y coordinate * @param w Width * @param h Height - * @param pixels Array of pixels (coded on 4 bytes in an int, 0xRRGGBBAA) + * @param pixels Array of pixels * * Note: it is responsability of the user to make sure the size of `pixels` is * big enough for the given region.