summaryrefslogtreecommitdiff
path: root/riscos
diff options
context:
space:
mode:
authorVincent Sanders <vince@kyllikki.org>2014-11-12 23:27:13 +0000
committerVincent Sanders <vince@kyllikki.org>2014-11-12 23:27:13 +0000
commit9fde3502b659d3858cd1978d2c6535c57efbe924 (patch)
tree05b81ded322deb7fb0b7c1b7fa4d88bbbff193fc /riscos
parente8277f2954229822fae75cb9b062b90a95c37a71 (diff)
downloadnetsurf-9fde3502b659d3858cd1978d2c6535c57efbe924.tar.gz
netsurf-9fde3502b659d3858cd1978d2c6535c57efbe924.tar.bz2
doxygen cleanups in utils
Diffstat (limited to 'riscos')
-rw-r--r--riscos/bitmap.c24
-rw-r--r--riscos/wimp.c10
-rw-r--r--riscos/wimp_event.c31
3 files changed, 36 insertions, 29 deletions
diff --git a/riscos/bitmap.c b/riscos/bitmap.c
index abb21ea50..c843be6e2 100644
--- a/riscos/bitmap.c
+++ b/riscos/bitmap.c
@@ -58,7 +58,7 @@
* Initialise a bitmaps sprite area.
*
* \param bitmap the bitmap to initialise
- * \param clear whether to clear the image ready for use
+ * \return true if bitmap initialised else false.
*/
static bool bitmap_initialise(struct bitmap *bitmap)
@@ -106,7 +106,7 @@ static bool bitmap_initialise(struct bitmap *bitmap)
*
* \param width width of image in pixels
* \param height width of image in pixels
- * \param clear whether to clear the image ready for use
+ * \param state the state to create teh bitmap in.
* \return an opaque struct bitmap, or NULL on memory exhaustion
*/
@@ -220,7 +220,7 @@ void bitmap_overlay_sprite(struct bitmap *bitmap, const osspriteop_header *s)
/**
* Sets whether a bitmap should be plotted opaque
*
- * \param bitmap a bitmap, as returned by bitmap_create()
+ * \param vbitmap a bitmap, as returned by bitmap_create()
* \param opaque whether the bitmap should be plotted opaque
*/
void bitmap_set_opaque(void *vbitmap, bool opaque)
@@ -238,7 +238,7 @@ void bitmap_set_opaque(void *vbitmap, bool opaque)
/**
* Tests whether a bitmap has an opaque alpha channel
*
- * \param bitmap a bitmap, as returned by bitmap_create()
+ * \param vbitmap a bitmap, as returned by bitmap_create()
* \return whether the bitmap is opaque
*/
bool bitmap_test_opaque(void *vbitmap)
@@ -287,7 +287,7 @@ bool bitmap_test_opaque(void *vbitmap)
/**
* Gets whether a bitmap should be plotted opaque
*
- * \param bitmap a bitmap, as returned by bitmap_create()
+ * \param vbitmap a bitmap, as returned by bitmap_create()
*/
bool bitmap_get_opaque(void *vbitmap)
{
@@ -300,11 +300,11 @@ bool bitmap_get_opaque(void *vbitmap)
/**
* Return a pointer to the pixel data in a bitmap.
*
- * \param bitmap a bitmap, as returned by bitmap_create()
- * \return pointer to the pixel buffer
- *
* The pixel data is packed as BITMAP_FORMAT, possibly with padding at the end
* of rows. The width of a row in bytes is given by bitmap_get_rowstride().
+ *
+ * \param vbitmap a bitmap, as returned by bitmap_create()
+ * \return pointer to the pixel buffer
*/
unsigned char *bitmap_get_buffer(void *vbitmap)
@@ -329,7 +329,7 @@ unsigned char *bitmap_get_buffer(void *vbitmap)
/**
* Find the width of a pixel row in bytes.
*
- * \param bitmap a bitmap, as returned by bitmap_create()
+ * \param vbitmap a bitmap, as returned by bitmap_create()
* \return width of a pixel row in the bitmap
*/
@@ -343,7 +343,7 @@ size_t bitmap_get_rowstride(void *vbitmap)
/**
* Free a bitmap.
*
- * \param bitmap a bitmap, as returned by bitmap_create()
+ * \param vbitmap a bitmap, as returned by bitmap_create()
*/
void bitmap_destroy(void *vbitmap)
@@ -364,7 +364,7 @@ void bitmap_destroy(void *vbitmap)
/**
* Save a bitmap in the platform's native format.
*
- * \param bitmap a bitmap, as returned by bitmap_create()
+ * \param vbitmap a bitmap, as returned by bitmap_create()
* \param path pathname for file
* \param flags modify the behaviour of the save
* \return true on success, false on error and error reported
@@ -537,7 +537,7 @@ bool bitmap_save(void *vbitmap, const char *path, unsigned flags)
/**
* The bitmap image has changed, so flush any persistent cache.
*
- * \param bitmap a bitmap, as returned by bitmap_create()
+ * \param vbitmap a bitmap, as returned by bitmap_create()
*/
void bitmap_modified(void *vbitmap) {
struct bitmap *bitmap = (struct bitmap *) vbitmap;
diff --git a/riscos/wimp.c b/riscos/wimp.c
index fe730a706..db6c2dbbb 100644
--- a/riscos/wimp.c
+++ b/riscos/wimp.c
@@ -114,7 +114,10 @@ void ro_gui_wimp_cache_furniture_sizes(wimp_w w)
/**
* Reads a modes EIG factors.
*
- * \param mode mode to read EIG factors for, or -1 for current
+ * \param[in] mode mode to read EIG factors for, or -1 for current
+ * \param[out] xeig The x eig value
+ * \param[out] yeig The y eig value
+ * \return true on success else false.
*/
bool ro_gui_wimp_read_eig_factors(os_mode mode, int *xeig, int *yeig)
{
@@ -955,8 +958,9 @@ bool ro_gui_wimp_get_sprite_dimensions(osspriteop_area *area, char *sprite,
/**
* Performs simple user redraw for a window.
*
- * \param user_fill whether to fill the redraw area
- * \param user_colour the colour to use when filling
+ * \param redraw wimp draw
+ * \param user_fill whether to fill the redraw area
+ * \param user_colour the colour to use when filling
*/
void ro_gui_user_redraw(wimp_draw *redraw, bool user_fill,
diff --git a/riscos/wimp_event.c b/riscos/wimp_event.c
index 40d704929..38f9b3d37 100644
--- a/riscos/wimp_event.c
+++ b/riscos/wimp_event.c
@@ -433,14 +433,17 @@ bool ro_gui_wimp_event_register_help_suffix(wimp_w w,
/**
* Get the associated help suffix.
*
- * \param w The window to get the suffix for
- * \return The associated prefix, or NULL
+ * \param w The window to get the suffix for
+ * \param i The icon
+ * \param pos The os coordinates
+ * \param buttons The button state.
+ * \return The associated prefix, or NULL
*/
const char *ro_gui_wimp_event_get_help_suffix(wimp_w w, wimp_i i,
os_coord *pos, wimp_mouse_state buttons)
{
- struct event_window *window;
+ struct event_window *window;
window = ro_gui_wimp_event_find_window(w);
if (window == NULL || window->get_help_suffix == NULL)
@@ -1157,8 +1160,8 @@ bool ro_gui_wimp_event_pointer_entering_window(wimp_entering *entering)
* Process a Menu click in a window, by checking for a registered window
* menu and opening it if one is found.
*
- * \param *p The pointer block from the mouse click event.
- * \return true if the click was actioned; else false.
+ * \param pointer The pointer block from the mouse click event.
+ * \return true if the click was actioned; else false.
*/
bool ro_gui_wimp_event_process_window_menu_click(wimp_pointer *pointer)
@@ -1233,16 +1236,16 @@ bool ro_gui_wimp_event_prepare_menu(wimp_w w, wimp_i i, wimp_menu *menu)
/**
* Register a window menu to be (semi-)automatically handled.
*
- * \param w The window to attach the menu to.
- * \param *m The menu to be attached.
- * \param menu_auto true if the menu should be opened autimatically
- * on Menu clicks with no task intervention; false
- * to pass clicks to the window's Mouse Event
- * handler and leave that to pass the menu click
- * back to us for handling and menu opening.
- * \param bool_position_ibar true if the menu should open in an iconbar
+ * \param w The window to attach the menu to.
+ * \param m The menu to be attached.
+ * \param menu_auto true if the menu should be opened autimatically on
+ * Menu clicks with no task intervention; false to pass
+ * clicks to the window's Mouse Event handler and leave
+ * that to pass the menu click back to us for handling
+ * and menu opening.
+ * \param position_ibar true if the menu should open in an iconbar
* position; false to open at the pointer.
- * \return true if the menu was registed ok; else false.
+ * \return true if the menu was registed ok; else false.
*/
bool ro_gui_wimp_event_register_menu(wimp_w w, wimp_menu *m,