summaryrefslogtreecommitdiff
path: root/frontends
diff options
context:
space:
mode:
authorVincent Sanders <vince@kyllikki.org>2017-02-14 23:05:30 +0000
committerVincent Sanders <vince@kyllikki.org>2017-02-14 23:06:04 +0000
commit6741b6e287bf89607eb6ce8378d79f7b4cf4b162 (patch)
tree438322cdbc1df19650ab0975519f6f7908ccae91 /frontends
parent20e3dc6d2ae7876b3fc0ce6c34e650e63c26b342 (diff)
downloadnetsurf-6741b6e287bf89607eb6ce8378d79f7b4cf4b162.tar.gz
netsurf-6741b6e287bf89607eb6ce8378d79f7b4cf4b162.tar.bz2
clean up incorrect documentation comments from plotter API rework
Diffstat (limited to 'frontends')
-rw-r--r--frontends/amiga/plotters.c10
-rw-r--r--frontends/amiga/sslcert.c2
-rw-r--r--frontends/atari/plot/plot.c2
-rw-r--r--frontends/atari/plot/plot.h3
-rw-r--r--frontends/framebuffer/framebuffer.c10
-rw-r--r--frontends/gtk/plotters.c58
-rw-r--r--frontends/gtk/print.c22
-rw-r--r--frontends/gtk/toolbar.c2
-rw-r--r--frontends/monkey/plot.c10
-rw-r--r--frontends/windows/plot.c10
10 files changed, 85 insertions, 44 deletions
diff --git a/frontends/amiga/plotters.c b/frontends/amiga/plotters.c
index 8a88917b8..e31d470a6 100644
--- a/frontends/amiga/plotters.c
+++ b/frontends/amiga/plotters.c
@@ -646,7 +646,7 @@ ami_clip(const struct redraw_context *ctx, const struct rect *clip)
* horizontal, in degrees.
*
* \param ctx The current redraw context.
- * \param pstyle Style controlling the arc plot.
+ * \param style 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.
@@ -680,7 +680,7 @@ ami_arc(const struct redraw_context *ctx,
* 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 style Style controlling the circle plot.
* \param x x coordinate of circle centre.
* \param y y coordinate of circle centre.
* \param radius circle radius.
@@ -717,7 +717,7 @@ ami_disc(const struct redraw_context *ctx,
* centre of line width/thickness.
*
* \param ctx The current redraw context.
- * \param pstyle Style controlling the line plot.
+ * \param style Style controlling the line plot.
* \param line A rectangle defining the line to be drawn
* \return NSERROR_OK on success else error code.
*/
@@ -769,7 +769,7 @@ ami_line(const struct redraw_context *ctx,
* width and height.
*
* \param ctx The current redraw context.
- * \param pstyle Style controlling the rectangle plot.
+ * \param style Style controlling the rectangle plot.
* \param rect A rectangle defining the line to be drawn
* \return NSERROR_OK on success else error code.
*/
@@ -831,7 +831,7 @@ ami_rectangle(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.
diff --git a/frontends/amiga/sslcert.c b/frontends/amiga/sslcert.c
index 5929f7e89..47126a011 100644
--- a/frontends/amiga/sslcert.c
+++ b/frontends/amiga/sslcert.c
@@ -194,6 +194,8 @@ ami_crtvrfy_key(struct ami_corewindow *ami_cw, uint32_t nskey)
* callback on draw event for certificate verify on core window
*
* \param ami_cw The Amiga core window structure.
+ * \param x the x coordinate to draw
+ * \param y the y coordinate to draw
* \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/atari/plot/plot.c b/frontends/atari/plot/plot.c
index 09174287c..2324f82d9 100644
--- a/frontends/atari/plot/plot.c
+++ b/frontends/atari/plot/plot.c
@@ -794,7 +794,7 @@ static MFDB * snapshot_create_native_mfdb(int x, int y, int w, int h)
* This creates an snapshot in RGBA format (NetSurf's native format)
*
* Capture the screen at x,y location
- * \param self instance
+ *
* \param x absolute screen coords
* \param y absolute screen coords
* \param w width
diff --git a/frontends/atari/plot/plot.h b/frontends/atari/plot/plot.h
index c8bf9157c..a827c008c 100644
--- a/frontends/atari/plot/plot.h
+++ b/frontends/atari/plot/plot.h
@@ -87,6 +87,7 @@ extern const struct plotter_table atari_plotters;
/**
* Init screen and font driver objects.
*
+ * \param ctx The current redraw context.
* \param fdrvrname font driver name.
* \return value > 1 when the objects could be succesfully created or
* <= 0 to indicate an error.
@@ -105,6 +106,8 @@ bool plot_unlock(void);
/**
* Set plot origin and canvas size
+ *
+ * \param ctx The current redraw context.
* \param x the x origin
* \param y the y origin
* \param w the width of the plot area
diff --git a/frontends/framebuffer/framebuffer.c b/frontends/framebuffer/framebuffer.c
index 7b8ee917f..649862aa3 100644
--- a/frontends/framebuffer/framebuffer.c
+++ b/frontends/framebuffer/framebuffer.c
@@ -77,7 +77,7 @@ framebuffer_plot_clip(const struct redraw_context *ctx, const struct rect *clip)
* horizontal, in degrees.
*
* \param ctx The current redraw context.
- * \param pstyle Style controlling the arc plot.
+ * \param style 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.
@@ -103,7 +103,7 @@ framebuffer_plot_arc(const struct redraw_context *ctx,
* 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 style Style controlling the circle plot.
* \param x x coordinate of circle centre.
* \param y y coordinate of circle centre.
* \param radius circle radius.
@@ -138,7 +138,7 @@ framebuffer_plot_disc(const struct redraw_context *ctx,
* centre of line width/thickness.
*
* \param ctx The current redraw context.
- * \param pstyle Style controlling the line plot.
+ * \param style Style controlling the line plot.
* \param line A rectangle defining the line to be drawn
* \return NSERROR_OK on success else error code.
*/
@@ -185,7 +185,7 @@ framebuffer_plot_line(const struct redraw_context *ctx,
* width and height.
*
* \param ctx The current redraw context.
- * \param pstyle Style controlling the rectangle plot.
+ * \param style Style controlling the rectangle plot.
* \param nsrect A rectangle defining the line to be drawn
* \return NSERROR_OK on success else error code.
*/
@@ -231,7 +231,7 @@ framebuffer_plot_rectangle(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.
diff --git a/frontends/gtk/plotters.c b/frontends/gtk/plotters.c
index 54b3a896c..bf4de08a6 100644
--- a/frontends/gtk/plotters.c
+++ b/frontends/gtk/plotters.c
@@ -44,9 +44,11 @@ cairo_t *current_cr;
static GdkRectangle cliprect;
-struct plotter_table plot;
-
-/** Set cairo context colour to nsgtk colour. */
+/**
+ * Set cairo context colour to nsgtk colour.
+ *
+ * \param c the netsurf colour to set in cairo
+ */
void nsgtk_set_colour(colour c)
{
cairo_set_source_rgba(current_cr,
@@ -56,21 +58,30 @@ void nsgtk_set_colour(colour c)
1.0);
}
-/** Set cairo context to solid plot operation. */
+
+/**
+ * Set cairo context to solid plot operation.
+ */
static inline void nsgtk_set_solid(void)
{
double dashes = 0;
cairo_set_dash(current_cr, &dashes, 0, 0);
}
-/** Set cairo context to dotted plot operation. */
+
+/**
+ * Set cairo context to dotted plot operation.
+ */
static inline void nsgtk_set_dotted(void)
{
double cdashes[] = { 1.0, 2.0 };
cairo_set_dash(current_cr, cdashes, 2, 0);
}
-/** Set cairo context to dashed plot operation. */
+
+/**
+ * Set cairo context to dashed plot operation.
+ */
static inline void nsgtk_set_dashed(void)
{
double cdashes[] = { 8.0, 2.0 };
@@ -111,7 +122,7 @@ nsgtk_plot_clip(const struct redraw_context *ctx, const struct rect *clip)
* horizontal, in degrees.
*
* \param ctx The current redraw context.
- * \param pstyle Style controlling the arc plot.
+ * \param style 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.
@@ -143,7 +154,7 @@ nsgtk_plot_arc(const struct redraw_context *ctx,
* 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 style Style controlling the circle plot.
* \param x x coordinate of circle centre.
* \param y y coordinate of circle centre.
* \param radius circle radius.
@@ -167,16 +178,16 @@ nsgtk_plot_disc(const struct redraw_context *ctx,
nsgtk_set_colour(style->stroke_colour);
switch (style->stroke_type) {
- case PLOT_OP_TYPE_SOLID: /**< Solid colour */
+ case PLOT_OP_TYPE_SOLID: /* Solid colour */
default:
nsgtk_set_solid();
break;
- case PLOT_OP_TYPE_DOT: /**< Doted plot */
+ case PLOT_OP_TYPE_DOT: /* Doted plot */
nsgtk_set_dotted();
break;
- case PLOT_OP_TYPE_DASH: /**< dashed plot */
+ case PLOT_OP_TYPE_DASH: /* dashed plot */
nsgtk_set_dashed();
break;
}
@@ -202,7 +213,7 @@ nsgtk_plot_disc(const struct redraw_context *ctx,
* centre of line width/thickness.
*
* \param ctx The current redraw context.
- * \param pstyle Style controlling the line plot.
+ * \param style Style controlling the line plot.
* \param line A rectangle defining the line to be drawn
* \return NSERROR_OK on success else error code.
*/
@@ -214,16 +225,16 @@ nsgtk_plot_line(const struct redraw_context *ctx,
nsgtk_set_colour(style->stroke_colour);
switch (style->stroke_type) {
- case PLOT_OP_TYPE_SOLID: /**< Solid colour */
+ case PLOT_OP_TYPE_SOLID: /* Solid colour */
default:
nsgtk_set_solid();
break;
- case PLOT_OP_TYPE_DOT: /**< Doted plot */
+ case PLOT_OP_TYPE_DOT: /* Doted plot */
nsgtk_set_dotted();
break;
- case PLOT_OP_TYPE_DASH: /**< dashed plot */
+ case PLOT_OP_TYPE_DASH: /* dashed plot */
nsgtk_set_dashed();
break;
}
@@ -280,7 +291,7 @@ void nsgtk_plot_caret(int x, int y, int h)
* width and height.
*
* \param ctx The current redraw context.
- * \param pstyle Style controlling the rectangle plot.
+ * \param style Style controlling the rectangle plot.
* \param rect A rectangle defining the line to be drawn
* \return NSERROR_OK on success else error code.
*/
@@ -307,16 +318,16 @@ nsgtk_plot_rectangle(const struct redraw_context *ctx,
nsgtk_set_colour(style->stroke_colour);
switch (style->stroke_type) {
- case PLOT_OP_TYPE_SOLID: /**< Solid colour */
+ case PLOT_OP_TYPE_SOLID: /* Solid colour */
default:
nsgtk_set_solid();
break;
- case PLOT_OP_TYPE_DOT: /**< Doted plot */
+ case PLOT_OP_TYPE_DOT: /* Doted plot */
nsgtk_set_dotted();
break;
- case PLOT_OP_TYPE_DASH: /**< dashed plot */
+ case PLOT_OP_TYPE_DASH: /* dashed plot */
nsgtk_set_dashed();
break;
}
@@ -346,7 +357,7 @@ nsgtk_plot_rectangle(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.
@@ -476,6 +487,13 @@ nsgtk_plot_path(const struct redraw_context *ctx,
/**
* plot a pixbuf
+ *
+ * \param x x coordinate to put pixmap
+ * \param y y coordinate to put pixmap
+ * \param width width of pixmap
+ * \param height height of pixmap
+ * \param bitmap The bitmap to plot
+ * \param bg the background colour
*/
static nserror
nsgtk_plot_pixbuf(int x, int y, int width, int height,
diff --git a/frontends/gtk/print.c b/frontends/gtk/print.c
index 4f3408166..d2ca29751 100644
--- a/frontends/gtk/print.c
+++ b/frontends/gtk/print.c
@@ -177,6 +177,12 @@ nsgtk_print_plot_clip(const struct redraw_context *ctx, const struct rect *clip)
* horizontal, in degrees.
*
* \param ctx The current redraw context.
+ * \param style 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
@@ -203,7 +209,10 @@ nsgtk_print_plot_arc(const struct redraw_context *ctx,
* 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 style 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
@@ -258,7 +267,7 @@ nsgtk_print_plot_disc(const struct redraw_context *ctx,
* centre of line width/thickness.
*
* \param ctx The current redraw context.
- * \param pstyle Style controlling the line plot.
+ * \param style Style controlling the line plot.
* \param line A rectangle defining the line to be drawn
* \return NSERROR_OK on success else error code.
*/
@@ -306,7 +315,7 @@ nsgtk_print_plot_line(const struct redraw_context *ctx,
* width and height.
*
* \param ctx The current redraw context.
- * \param pstyle Style controlling the rectangle plot.
+ * \param style Style controlling the rectangle plot.
* \param rect A rectangle defining the line to be drawn
* \return NSERROR_OK on success else error code.
*/
@@ -559,6 +568,13 @@ static bool nsgtk_print_plot_pixbuf(int x, int y, int width, int height,
* 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
diff --git a/frontends/gtk/toolbar.c b/frontends/gtk/toolbar.c
index ac24a78ca..1f8dbbb7c 100644
--- a/frontends/gtk/toolbar.c
+++ b/frontends/gtk/toolbar.c
@@ -125,6 +125,7 @@ static char *remove_underscores(const char *s, bool replacespace)
*
* \param tbbutton button reference
* \param iconsize The size of icons to select.
+ * \param usedef Use the default image if not found.
* \return default images.
*/
static GtkImage *
@@ -193,6 +194,7 @@ nsgtk_theme_image_default(nsgtk_toolbar_button tbbutton,
*
* \param tbbutton search button reference
* \param iconsize The size of icons to select.
+ * \param usedef Use the default image if not found.
* \return default search image.
*/
diff --git a/frontends/monkey/plot.c b/frontends/monkey/plot.c
index 9eb40acba..7ed2205ca 100644
--- a/frontends/monkey/plot.c
+++ b/frontends/monkey/plot.c
@@ -48,7 +48,7 @@ monkey_plot_clip(const struct redraw_context *ctx, const struct rect *clip)
* horizontal, in degrees.
*
* \param ctx The current redraw context.
- * \param pstyle Style controlling the arc plot.
+ * \param style 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.
@@ -74,7 +74,7 @@ monkey_plot_arc(const struct redraw_context *ctx,
* 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 style Style controlling the circle plot.
* \param x x coordinate of circle centre.
* \param y y coordinate of circle centre.
* \param radius circle radius.
@@ -99,7 +99,7 @@ monkey_plot_disc(const struct redraw_context *ctx,
* centre of line width/thickness.
*
* \param ctx The current redraw context.
- * \param pstyle Style controlling the line plot.
+ * \param style Style controlling the line plot.
* \param line A rectangle defining the line to be drawn
* \return NSERROR_OK on success else error code.
*/
@@ -124,7 +124,7 @@ monkey_plot_line(const struct redraw_context *ctx,
* width and height.
*
* \param ctx The current redraw context.
- * \param pstyle Style controlling the rectangle plot.
+ * \param style Style controlling the rectangle plot.
* \param rect A rectangle defining the line to be drawn
* \return NSERROR_OK on success else error code.
*/
@@ -149,7 +149,7 @@ monkey_plot_rectangle(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.
diff --git a/frontends/windows/plot.c b/frontends/windows/plot.c
index 5b7648ef1..b733dfd84 100644
--- a/frontends/windows/plot.c
+++ b/frontends/windows/plot.c
@@ -362,7 +362,7 @@ static nserror clip(const struct redraw_context *ctx, const struct rect *clip)
* horizontal, in degrees.
*
* \param ctx The current redraw context.
- * \param pstyle Style controlling the arc plot.
+ * \param style 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.
@@ -477,7 +477,7 @@ arc(const struct redraw_context *ctx,
* 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 style Style controlling the circle plot.
* \param x x coordinate of circle centre.
* \param y y coordinate of circle centre.
* \param radius circle radius.
@@ -558,7 +558,7 @@ disc(const struct redraw_context *ctx,
* centre of line width/thickness.
*
* \param ctx The current redraw context.
- * \param pstyle Style controlling the line plot.
+ * \param style Style controlling the line plot.
* \param line A rectangle defining the line to be drawn
* \return NSERROR_OK on success else error code.
*/
@@ -624,7 +624,7 @@ line(const struct redraw_context *ctx,
* width and height.
*
* \param ctx The current redraw context.
- * \param pstyle Style controlling the rectangle plot.
+ * \param style Style controlling the rectangle plot.
* \param rect A rectangle defining the line to be drawn
* \return NSERROR_OK on success else error code.
*/
@@ -706,7 +706,7 @@ rectangle(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.