From 0f69965805dda51cc7b6ea8404226d5f75a3b533 Mon Sep 17 00:00:00 2001 From: Vincent Sanders Date: Sun, 19 Feb 2017 11:32:17 +0000 Subject: clean up some of the doxygen generation warnings --- frontends/amiga/bitmap.h | 3 +-- frontends/amiga/cookies.c | 4 +++- frontends/amiga/corewindow.c | 12 +++++++----- frontends/amiga/corewindow.h | 2 +- frontends/amiga/history.c | 6 +++++- frontends/amiga/hotlist.c | 5 ++++- frontends/amiga/sslcert.c | 2 +- 7 files changed, 22 insertions(+), 12 deletions(-) (limited to 'frontends/amiga') diff --git a/frontends/amiga/bitmap.h b/frontends/amiga/bitmap.h index 17939d79a..aaec26ac2 100755 --- a/frontends/amiga/bitmap.h +++ b/frontends/amiga/bitmap.h @@ -76,8 +76,7 @@ void ami_bitmap_set_icondata(struct bitmap *bm, ULONG *icondata); /** * Free an icondata pointer * - * \param bm a bitmap, as returned by bitmap_create() - * \param icondata a pointer to memory + * \param bm a bitmap, as returned by bitmap_create() * * This function probably shouldn't be here! */ diff --git a/frontends/amiga/cookies.c b/frontends/amiga/cookies.c index 877805cda..fd71a9c2a 100644 --- a/frontends/amiga/cookies.c +++ b/frontends/amiga/cookies.c @@ -136,7 +136,7 @@ ami_cookies_mouse(struct ami_corewindow *ami_cw, /** * callback for keypress for cookies viewer on core window * - * \param example_cw The Amiga core window structure. + * \param ami_cw The Amiga core window structure. * \param nskey The netsurf key code * \return NSERROR_OK on success otherwise apropriate error code */ @@ -153,6 +153,8 @@ ami_cookies_key(struct ami_corewindow *ami_cw, uint32_t nskey) * callback on draw event for cookies viewer on core window * * \param ami_cw The Amiga core window structure. + * \param x The x cordinate to plot at + * \param y The y cordinate to plot at * \param r The rectangle of the window that needs updating. * \param ctx The drawing context * \return NSERROR_OK on success otherwise apropriate error code diff --git a/frontends/amiga/corewindow.c b/frontends/amiga/corewindow.c index 84861e073..86c21b8a1 100644 --- a/frontends/amiga/corewindow.c +++ b/frontends/amiga/corewindow.c @@ -203,15 +203,16 @@ ami_cw_key(struct ami_corewindow *ami_cw, int nskey) /** * Redraw functions * - * This is slightly over-engineered as it was taken from the main browser/old tree redraws - * and supports deferred drawing of rectangles and tiling + * This is slightly over-engineered as it was taken from the main + * browser/old tree redraws and supports deferred drawing of + * rectangles and tiling */ /** * Redraw an area of a core window * - * \param g a struct ami_corewindow - * \param r rect (in document co-ordinates) + * \param ami_cw An Amiga core window structure + * \param r rect (in document co-ordinates) */ static void @@ -302,7 +303,8 @@ ami_cw_redraw_rect(struct ami_corewindow *ami_cw, struct rect *r) /** * Draw the deferred rectangles * - * @param draw set to false to just delete the queue + * \param ami_cw An Amiga core window structure to queue redraw + * \param draw set to false to just delete the queue */ static void ami_cw_redraw_queue(struct ami_corewindow *ami_cw, bool draw) { diff --git a/frontends/amiga/corewindow.h b/frontends/amiga/corewindow.h index cc4fe4adb..ea01f67f1 100644 --- a/frontends/amiga/corewindow.h +++ b/frontends/amiga/corewindow.h @@ -171,7 +171,7 @@ struct ami_corewindow { * * As a pre-requisite the draw, key and mouse callbacks must be defined * - * \param example_cw An Amiga core window structure to initialise + * \param ami_cw An Amiga core window structure to initialise * \return NSERROR_OK on successful initialisation otherwise error code. */ nserror ami_corewindow_init(struct ami_corewindow *ami_cw); diff --git a/frontends/amiga/history.c b/frontends/amiga/history.c index 12c306a9b..7fc1ec333 100644 --- a/frontends/amiga/history.c +++ b/frontends/amiga/history.c @@ -162,12 +162,16 @@ ami_history_global_key(struct ami_corewindow *ami_cw, uint32_t nskey) * callback on draw event for history viewer on core window * * \param ami_cw The Amiga core window structure. + * \param x The x coordinate of global history area to redraw + * \param y The y coordinate of global history area to redraw * \param r The rectangle of the window that needs updating. * \param ctx The drawing context * \return NSERROR_OK on success otherwise apropriate error code */ static nserror -ami_history_global_draw(struct ami_corewindow *ami_cw, int x, int y, struct rect *r, struct redraw_context *ctx) +ami_history_global_draw(struct ami_corewindow *ami_cw, + int x, int y, struct rect *r, + struct redraw_context *ctx) { global_history_redraw(x, y, r, ctx); diff --git a/frontends/amiga/hotlist.c b/frontends/amiga/hotlist.c index 008e45a24..c0a6b6f58 100644 --- a/frontends/amiga/hotlist.c +++ b/frontends/amiga/hotlist.c @@ -213,12 +213,15 @@ ami_hotlist_key(struct ami_corewindow *ami_cw, uint32_t nskey) * callback on draw event for hotlist viewer on core window * * \param ami_cw The Amiga core window structure. + * \param x The x coordinate of hotlist area to redraw + * \param y The y coordinate of hotlist area to redraw * \param r The rectangle of the window that needs updating. * \param ctx The drawing context * \return NSERROR_OK on success otherwise apropriate error code */ static nserror -ami_hotlist_draw(struct ami_corewindow *ami_cw, int x, int y, struct rect *r, struct redraw_context *ctx) +ami_hotlist_draw(struct ami_corewindow *ami_cw, + int x, int y, struct rect *r, struct redraw_context *ctx) { hotlist_redraw(x, y, r, ctx); diff --git a/frontends/amiga/sslcert.c b/frontends/amiga/sslcert.c index 47126a011..eeb34108a 100644 --- a/frontends/amiga/sslcert.c +++ b/frontends/amiga/sslcert.c @@ -172,7 +172,7 @@ ami_crtvrfy_mouse(struct ami_corewindow *ami_cw, /** * callback for keypress for certificate verify on core window * - * \param example_cw The Amiga core window structure. + * \param ami_cw The Amiga core window structure. * \param nskey The netsurf key code * \return NSERROR_OK on success otherwise apropriate error code */ -- cgit v1.2.3