From fbe9f636b08d86bc10427283e35d60d2900aa5cc Mon Sep 17 00:00:00 2001 From: Michael Drake Date: Sun, 1 Jan 2023 18:06:08 +0000 Subject: docs: Various doxygen comment fixes --- include/nsgif.h | 15 ++++++++------- src/gif.c | 14 ++++++++------ test/cli.c | 1 - 3 files changed, 16 insertions(+), 14 deletions(-) diff --git a/include/nsgif.h b/include/nsgif.h index 7e6aa83..7df8981 100644 --- a/include/nsgif.h +++ b/include/nsgif.h @@ -166,15 +166,14 @@ typedef enum nsgif_bitmap_fmt { /** * Client bitmap type. * - * These are client-created and destroyed, via the \ref bitmap callbacks, - * but they are owned by a \ref nsgif_t. + * These are client-created and destroyed, via the \ref nsgif_bitmap_cb_vt + * callbacks, but they are owned by a \ref nsgif_t. * * See \ref nsgif_bitmap_fmt for pixel format information. * * The bitmap may have a row_span greater than the bitmap width, but the * difference between row span and width must be a whole number of pixels - * (a multiple of four bytes). If row span is greater than width, the - * \ref get_rowspan callback must be provided. + * (a multiple of four bytes). */ typedef void nsgif_bitmap_t; @@ -238,6 +237,8 @@ typedef struct nsgif_bitmap_cb_vt { * * If this callback is not provided, LibNSGIF will use the width. * + * If row span is greater than width, this callback must be provided. + * * \param[in] bitmap The bitmap. */ uint32_t (*get_rowspan)(nsgif_bitmap_t *bitmap); @@ -485,7 +486,7 @@ void nsgif_global_palette( * Colours in same pixel format as \ref nsgif_bitmap_t. * * \param[in] gif The \ref nsgif_t object. - * \param[in] frame The \ref frame to get the palette for. + * \param[in] frame The frame to get the palette for. * \param[out] table Client buffer to hold the colour table. * \param[out] entries The number of used entries in the colour table. * \return true if a palette is returned, false otherwise. @@ -511,7 +512,7 @@ bool nsgif_local_palette( * * Both the minimum and the default values can be overridden for a given GIF * by the client. To get frame delays exactly as specified by the GIF file, set - * \ref delay_min to zero. + * `delay_min` to zero. * * Note that this does not affect the frame delay in the frame info * (\ref nsgif_frame_info_t) structure, which will always contain values @@ -520,7 +521,7 @@ bool nsgif_local_palette( * \param[in] gif The \ref nsgif_t object to configure. * \param[in] delay_min The minimum frame delay in centiseconds. * \param[in] delay_default The delay to use if a frame delay is less than - * \ref delay_min. + * `delay_min`. */ void nsgif_set_frame_delay_behaviour( nsgif_t *gif, diff --git a/src/gif.c b/src/gif.c index 688fe12..44c60a9 100644 --- a/src/gif.c +++ b/src/gif.c @@ -1068,7 +1068,7 @@ static nsgif_error nsgif__parse_image_descriptor( * \param[in] colour_table The colour table to populate. * \param[in] layout la. * \param[in] colour_table_entries The number of colour table entries. - * \param[in] Data Raw colour table data. + * \param[in] data Raw colour table data. */ static void nsgif__colour_table_decode( uint32_t colour_table[NSGIF_MAX_COLOURS], @@ -1097,11 +1097,13 @@ static void nsgif__colour_table_decode( /** * Extract a GIF colour table into a LibNSGIF colour table buffer. * - * \param[in] gif The gif object we're decoding. - * \param[in] colour_table The colour table to populate. - * \param[in] colour_table_entries The number of colour table entries. - * \param[in] pos Current position in data, updated on exit. - * \param[in] decode Whether to decode the colour table. + * \param[in] colour_table The colour table to populate. + * \param[in] layout The target pixel format to decode to. + * \param[in] colour_table_entries The number of colour table entries. + * \param[in] data Current position in data. + * \param[in] data_len The available length of `data`. + * \param[out] used Number of colour table bytes read. + * \param[in] decode Whether to decode the colour table. * \return NSGIF_OK on success, appropriate error otherwise. */ static inline nsgif_error nsgif__colour_table_extract( diff --git a/test/cli.c b/test/cli.c index 851750c..9c095fe 100644 --- a/test/cli.c +++ b/test/cli.c @@ -340,7 +340,6 @@ static bool cli__parse_positional_entry(struct cli_ctx *ctx, * * \param[in] ctx Command line interface parsing context. * \param[in] arg Argument to parse. - * \param[in] count Number of positional arguments parsed already. * \return true on success, or false otherwise. */ static bool cli__parse_positional(struct cli_ctx *ctx, -- cgit v1.2.1