From 1820bb7e637206b7d4b103d32aff364e5e5b529c Mon Sep 17 00:00:00 2001 From: Vincent Sanders Date: Wed, 22 Feb 2017 08:30:58 +0000 Subject: fix remaining doccomment errors --- desktop/knockout.c | 39 +++++++++++++++++++++++++++++++++++---- desktop/local_history.h | 12 +++++++++--- 2 files changed, 44 insertions(+), 7 deletions(-) (limited to 'desktop') diff --git a/desktop/knockout.c b/desktop/knockout.c index 3647a3a7b..ee66c17d2 100644 --- a/desktop/knockout.c +++ b/desktop/knockout.c @@ -381,6 +381,7 @@ static nserror knockout_plot_flush(const struct redraw_context *ctx) /** * Knockout a section of previous rendering * + * \param ctx The current redraw context. * \param x0 The left edge of the removal box * \param y0 The bottom edge of the removal box * \param x1 The right edge of the removal box @@ -516,6 +517,7 @@ knockout_calculate(const struct redraw_context *ctx, * * \param ctx The current redraw context. * \param pstyle Style controlling the rectangle plot. + * \param rect A rectangle defining the line to be drawn * \return NSERROR_OK on success else error code. */ static nserror @@ -575,11 +577,12 @@ knockout_plot_rectangle(const struct redraw_context *ctx, /** * Knockout line plotting. * - * plot a line from (x0,y0) to (x1,y1). Coordinates are at centre of - * line width/thickness. + * plot a line from (x0,y0) to (x1,y1). Coordinates are at + * centre of line width/thickness. * * \param ctx The current redraw context. * \param pstyle Style controlling the line plot. + * \param line A rectangle defining the line to be drawn * \return NSERROR_OK on success else error code. */ static nserror @@ -606,7 +609,9 @@ knockout_plot_line(const struct redraw_context *ctx, * rule. * * \param ctx The current redraw context. - * \param pstyle Style controlling the polygon plot. + * \param style Style controlling the polygon plot. + * \param p verticies of polygon + * \param n number of verticies. * \return NSERROR_OK on success else error code. */ static nserror @@ -750,11 +755,15 @@ knockout_plot_text(const struct redraw_context *ctx, /** - * Plots a circle + * knockout circle plotting * * Plot a circle centered on (x,y), which is optionally filled. * * \param ctx The current redraw context. + * \param pstyle Style controlling the circle plot. + * \param x x coordinate of circle centre. + * \param y y coordinate of circle centre. + * \param radius circle radius. * \return NSERROR_OK on success else error code. */ static nserror @@ -786,6 +795,12 @@ knockout_plot_disc(const struct redraw_context *ctx, * horizontal, in degrees. * * \param ctx The current redraw context. + * \param pstyle Style controlling the arc plot. + * \param x The x coordinate of the arc. + * \param y The y coordinate of the arc. + * \param radius The radius of the arc. + * \param angle1 The start angle of the arc. + * \param angle2 The finish angle of the arc. * \return NSERROR_OK on success else error code. */ static nserror @@ -828,6 +843,13 @@ knockout_plot_arc(const struct redraw_context *ctx, * the image is to be scaled to. * * \param ctx The current redraw context. + * \param bitmap The bitmap to plot + * \param x The x coordinate to plot the bitmap + * \param y The y coordiante to plot the bitmap + * \param width The width of area to plot the bitmap into + * \param height The height of area to plot the bitmap into + * \param bg the background colour to alpha blend into + * \param flags the flags controlling the type of plot operation * \return NSERROR_OK on success else error code. */ static nserror @@ -905,6 +927,7 @@ knockout_plot_bitmap(const struct redraw_context *ctx, * Used when plotter implements export to a vector graphics file format. * * \param ctx The current redraw context. + * \param name The name of the group being started. * \return NSERROR_OK on success else error code. */ static nserror @@ -923,6 +946,14 @@ knockout_plot_group_start(const struct redraw_context *ctx, const char *name) } +/** + * End a group of objects. + * + * Used when plotter implements export to a vector graphics file format. + * + * \param ctx The current redraw context. + * \return NSERROR_OK on success else error code. + */ static nserror knockout_plot_group_end(const struct redraw_context *ctx) { if (real_plot.group_end == NULL) { diff --git a/desktop/local_history.h b/desktop/local_history.h index a23cbd3ed..5425e700b 100644 --- a/desktop/local_history.h +++ b/desktop/local_history.h @@ -42,6 +42,7 @@ struct browser_window; * * \param cw_t Callback table for core_window containing the treeview. * \param core_window_handle The core_window in which the treeview is shown. + * \param bw browser window to show history of. * \param[out] session The created local history session context. * \return NSERROR_OK on success and session set, appropriate error code otherwise */ @@ -67,8 +68,8 @@ nserror local_history_fini(struct local_history_session *session); * Redraw the global history. * * \param session The local history session context. - * \param x X coordinate to render treeview at - * \param y Y coordinate to render treeview at + * \param x X coordinate to render history at + * \param y Y coordinate to render history at * \param clip Current clip rectangle (wrt tree origin) * \param ctx Current redraw context */ @@ -87,8 +88,8 @@ void local_history_mouse_action(struct local_history_session *session, enum brow /** * Key press handling. * - * \param key The ucs4 character codepoint * \param session The local history session context. + * \param key The ucs4 character codepoint * \return true if the keypress is dealt with, false otherwise. */ bool local_history_keypress(struct local_history_session *session, uint32_t key); @@ -97,6 +98,8 @@ bool local_history_keypress(struct local_history_session *session, uint32_t key) * Change the browser window to draw local history for. * * \param session The local history session context. + * \param bw browser window to show history of. + * \return NSERROR_OK or appropriate error code. */ nserror local_history_set(struct local_history_session *session, struct browser_window *bw); @@ -104,6 +107,9 @@ nserror local_history_set(struct local_history_session *session, struct browser_ * get size of local history content area * * \param session The local history session context. + * \param[out] width on sucessful return the width of the localhistory content + * \param[out] height on sucessful return the height of the localhistory content + * \return NSERROR_OK or appropriate error code. */ nserror local_history_get_size(struct local_history_session *session, int *width, int *height); -- cgit v1.2.3