diff options
| author | Michael Drake <tlsa@netsurf-browser.org> | 2021-11-24 14:23:07 +0000 |
|---|---|---|
| committer | Michael Drake <tlsa@netsurf-browser.org> | 2021-11-24 14:23:07 +0000 |
| commit | 125cd0409ab9d2d13fc41fcfae2fe001e4241878 (patch) | |
| tree | c29f2d7093968c9a3c88279aeb60460380d1dffa /src/libnsgif.c | |
| parent | 032e62c80df60b5fcedcd75f3043e0a18e114b6e (diff) | |
| download | libnsgif-125cd0409ab9d2d13fc41fcfae2fe001e4241878.tar.gz libnsgif-125cd0409ab9d2d13fc41fcfae2fe001e4241878.tar.bz2 | |
GIF: Update code documentation.
Diffstat (limited to 'src/libnsgif.c')
| -rw-r--r-- | src/libnsgif.c | 21 |
1 files changed, 14 insertions, 7 deletions
diff --git a/src/libnsgif.c b/src/libnsgif.c index 6c21a7c..6f59b3a 100644 --- a/src/libnsgif.c +++ b/src/libnsgif.c @@ -150,7 +150,7 @@ static inline void gif__bitmap_modified( * Helper to tell the client that whether the bitmap is opaque. * * \param[in] gif The gif object we're decoding. - * \param[in] frmae The frame that has been decoded. + * \param[in] frame The frame that has been decoded. */ static inline void gif__bitmap_set_opaque( const struct gif_animation *gif, @@ -646,6 +646,7 @@ static gif_result gif__parse_extension_application( * * \param[in] gif The gif object we're decoding. * \param[in] frame The frame to parse extensions for. + * \param[in] pos Current position in data, updated on exit. * \param[in] decode Whether to decode or skip over the extension. * \return GIF_INSUFFICIENT_DATA if more data is needed, * GIF_OK for success. @@ -754,8 +755,10 @@ static gif_result gif__parse_frame_extensions( * 2BITS Reserved * 3BITS Size of Local Colour Table * - * \param[in] gif The gif object we're decoding. - * \param[in] frame The frame to parse an image descriptor for. + * \param[in] gif The gif object we're decoding. + * \param[in] frame The frame to parse an image descriptor for. + * \param[in] pos Current position in data, updated on exit. + * \param[in] decode Whether to decode the image descriptor. * \return GIF_OK on success, appropriate error otherwise. */ static gif_result gif__parse_image_descriptor( @@ -858,8 +861,10 @@ static gif_result gif__colour_table_extract( * * Sets up gif->colour_table for the frame. * - * \param[in] gif The gif object we're decoding. - * \param[in] frame The frame to get the colour table for. + * \param[in] gif The gif object we're decoding. + * \param[in] frame The frame to get the colour table for. + * \param[in] pos Current position in data, updated on exit. + * \param[in] decode Whether to decode the colour table. * \return GIF_OK on success, appropriate error otherwise. */ static gif_result gif__parse_colour_table( @@ -894,8 +899,10 @@ static gif_result gif__parse_colour_table( * * Sets up gif->colour_table for the frame. * - * \param[in] gif The gif object we're decoding. - * \param[in] frame The frame to get the colour table for. + * \param[in] gif The gif object we're decoding. + * \param[in] frame The frame to parse image data for. + * \param[in] pos Current position in data, updated on exit. + * \param[in] decode Whether to decode the image data. * \return GIF_OK on success, appropriate error otherwise. */ static gif_result gif__parse_image_data( |