From c830d14d0bd06dda4eaf7de27ae97b826173afe1 Mon Sep 17 00:00:00 2001 From: Vincent Sanders Date: Tue, 13 Sep 2016 09:16:31 +0100 Subject: cleanup seevral doxygen warnings --- frontends/amiga/bitmap.h | 4 ++-- frontends/atari/font.c | 4 ++-- frontends/atari/plot/plot.c | 2 +- frontends/framebuffer/gui.c | 2 +- frontends/windows/gui.h | 2 +- include/netsurf/content.h | 8 +++++--- render/box.h | 2 +- render/html_redraw.c | 6 +++--- render/layout.h | 2 +- utils/messages.h | 1 + 10 files changed, 18 insertions(+), 15 deletions(-) diff --git a/frontends/amiga/bitmap.h b/frontends/amiga/bitmap.h index 9a657a60a..771ded487 100755 --- a/frontends/amiga/bitmap.h +++ b/frontends/amiga/bitmap.h @@ -43,8 +43,8 @@ struct bitmap *ami_bitmap_from_datatype(char *filename); /** * Set bitmap URL * - * \param bm a bitmap, as returned by bitmap_create() - * \param title a pointer to a title string + * \param bm a bitmap, as returned by bitmap_create() + * \param url the url for the bitmap * * A reference will be kept by the bitmap object. * The URL can only ever be set once for a bitmap. diff --git a/frontends/atari/font.c b/frontends/atari/font.c index 85fecced2..5402e7870 100644 --- a/frontends/atari/font.c +++ b/frontends/atari/font.c @@ -122,7 +122,7 @@ atari_font_split(const plot_font_style_t *fstyle, * Measure the width of a string. * * \param[in] fstyle plot style for this text - * \param[in] string UTF-8 string to measure + * \param[in] str UTF-8 string to measure * \param[in] length length of string, in bytes * \param[out] width updated to width of string[0..length) * \return NSERROR_OK and width updated or appropriate error code on faliure @@ -131,7 +131,7 @@ static nserror atari_font_width(const plot_font_style_t *fstyle, const char *str, size_t length, - int * width) + int *width) { float scale = plot_get_scale(); diff --git a/frontends/atari/plot/plot.c b/frontends/atari/plot/plot.c index 2d0805d7e..0a0d7a494 100644 --- a/frontends/atari/plot/plot.c +++ b/frontends/atari/plot/plot.c @@ -387,7 +387,7 @@ bool plot_copy_rect(GRECT src, GRECT dst) /** * Fill the screen info structure. * - * \param vdhi The handle + * \param vdih The handle * \param[out] info The infor structure to fill. */ static void read_vdi_sysinfo(short vdih, struct s_vdi_sysinfo * info) { diff --git a/frontends/framebuffer/gui.c b/frontends/framebuffer/gui.c index 4936116c2..4d4c7334f 100644 --- a/frontends/framebuffer/gui.c +++ b/frontends/framebuffer/gui.c @@ -112,7 +112,7 @@ static void die(const char *error) /** * Warn the user of an event. * - * \param[in] message A warning looked up in the message translation table + * \param[in] warning A warning looked up in the message translation table * \param[in] detail Additional text to be displayed or NULL. * \return NSERROR_OK on success or error code if there was a * faliure displaying the message to the user. diff --git a/frontends/windows/gui.h b/frontends/windows/gui.h index 4c3f360b1..e4671eac1 100644 --- a/frontends/windows/gui.h +++ b/frontends/windows/gui.h @@ -48,7 +48,7 @@ void win32_set_quit(bool q); /** * Warn the user of an event. * - * \param[in] message A warning looked up in the message translation table + * \param[in] warning A warning looked up in the message translation table * \param[in] detail Additional text to be displayed or NULL. * \return NSERROR_OK on success or error code if there was a * faliure displaying the message to the user. diff --git a/include/netsurf/content.h b/include/netsurf/content.h index 3f3a30c0e..35b8b3365 100644 --- a/include/netsurf/content.h +++ b/include/netsurf/content.h @@ -148,9 +148,11 @@ void content_invalidate_reuse_data(struct hlcache_handle *h); /** * Display content on screen with optional tiling. * - * \param h The content to redraw - * \param ctx current redraw context - * \return true if successful, false otherwise + * \param h The content to redraw. + * \param data The contents redraw data. + * \param clip The clipping rectangle to use when redrawing the content. + * \param ctx current redraw context. + * \return true if successful otherwise false. * * Calls the redraw function for the content. */ diff --git a/render/box.h b/render/box.h index 79ff44da2..2800d4026 100644 --- a/render/box.h +++ b/render/box.h @@ -341,7 +341,7 @@ void box_dump(FILE *stream, struct box *box, unsigned int depth, bool style); * attempting to read a real URL from "javascript:" links. * * \param content html content - * \param ds rel relative URL text taken from page + * \param dsrel relative URL text taken from page * \param base base for relative URLs * \param result updated to target URL on heap, unchanged if extract failed * \return true on success, false on memory exhaustion diff --git a/render/html_redraw.c b/render/html_redraw.c index 7e0f7c286..ae8675671 100644 --- a/render/html_redraw.c +++ b/render/html_redraw.c @@ -1305,13 +1305,13 @@ static bool html_redraw_file(int x, int y, int width, int height, * \param scale scale for redraw * \param clip current clip rectangle * \param background_colour current background colour - * \param background box containing background details (usually ::box) + * \param background box containing background details (usually \a box) * \param ctx current redraw context * \return true if successful, false otherwise * * The reason for the presence of ::background is the backwards compatibility - * mess that is backgrounds on . The background will be drawn relative - * to ::box, using the background information contained within ::background. + * mess that is backgrounds on <body>. The background will be drawn relative + * to \a box, using the background information contained within \a background. */ static bool html_redraw_background(int x, int y, struct box *box, float scale, diff --git a/render/layout.h b/render/layout.h index ff0da5a53..78a30028e 100644 --- a/render/layout.h +++ b/render/layout.h @@ -45,7 +45,7 @@ bool layout_document(struct html_content *content, int width, int height); /** * Layout lines of text or inline boxes with floats. * - * \param inline_container inline container box + * \param box inline container box * \param width horizontal space available * \param cont ancestor box which defines horizontal space, for floats * \param cx box position relative to cont diff --git a/utils/messages.h b/utils/messages.h index ac1ea985d..784e5fe6a 100644 --- a/utils/messages.h +++ b/utils/messages.h @@ -57,6 +57,7 @@ nserror messages_add_from_file(const char *path); * data may be gzip compressed. * * \param data The inline message data. + * \param data_size The length of the message data. * \return NSERROR_OK on success or error code on faliure. */ nserror messages_add_from_inline(const uint8_t *data, size_t data_size); -- cgit v1.2.3