mirrors/netsurf
1
0
Fork 0
mirror of https://github.com/netsurf-browser/netsurf synced 2024-12-16 01:02:36 +03:00
Code Issues Packages Projects Releases Wiki Activity

Doxygen warning fixes

Browse Source
This commit is contained in:
Vincent Sanders 2014-11-10 20:15:14 +00:00
parent 345cfc4ec8
commit 33eb1f413a
11 changed files with 41 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
atari/download.c
View File

@ -415,7 +415,7 @@ static void gui_download_window_error(struct gui_download_window *dw,
strncpy((char*)&dw->lbl_file, error_msg, MAX_SLEN_LBL_FILE-1);
dw->status = NSATARI_DOWNLOAD_ERROR;
gemtk_wm_exec_redraw(dw->guiwin, NULL);
gui_window_set_status(input_window, messages_get("Done") );
atari_window_set_status(input_window, messages_get("Done") );
// TODO: change abort to close
}
@ -443,7 +443,7 @@ static void gui_download_window_done(struct gui_download_window *dw)
);
gemtk_wm_exec_redraw(dw->guiwin, NULL);
}
gui_window_set_status(input_window, messages_get("Done") );
atari_window_set_status(input_window, messages_get("Done") );
}
static struct gui_download_table download_table = {

4
atari/gui.c
View File

@ -357,7 +357,7 @@ static void gui_window_set_title(struct gui_window *gw, const char *title)
}
/* exported interface documented in atari/gui.h */
void gui_window_set_status(struct gui_window *w, const char *text)
void atari_window_set_status(struct gui_window *w, const char *text)
{
int l;
if (w == NULL || text == NULL)
@ -1066,7 +1066,7 @@ static struct gui_window_table atari_window_table = {
.set_title = gui_window_set_title,
.set_url = gui_window_set_url,
.set_icon = gui_window_set_icon,
.set_status = gui_window_set_status,
.set_status = atari_window_set_status,
.set_pointer = gui_window_set_pointer,
.place_caret = gui_window_place_caret,
.remove_caret = gui_window_remove_caret,

4
atari/gui.h
View File

@ -157,7 +157,7 @@ struct gui_window {
extern struct gui_window *window_list;
/* -------------------------------------------------------------------------- */
/* Public - non core gui window functions */
/* Public - non core gui window functions */
/* -------------------------------------------------------------------------- */
void gui_set_input_gui_window(struct gui_window *gw);
struct gui_window *gui_get_input_window(void);
@ -170,7 +170,7 @@ char *gui_window_get_title(struct gui_window *gw);
* \param w The gui_window to update.
* \param text new status text
*/
void gui_window_set_status(struct gui_window *w, const char *text);
void atari_window_set_status(struct gui_window *w, const char *text);
void gui_window_set_pointer(struct gui_window *gw, gui_pointer_shape shape);
void gui_window_destroy(struct gui_window *w);

5
gtk/theme.c
View File

@ -383,8 +383,11 @@ void nsgtk_theme_implement(struct nsgtk_scaffolding *g)
}
/**
* returns default image for buttons / menu items from gtk stock items
* get default image for buttons / menu items from gtk stock items.
*
* \param tbbutton button reference
* \param iconsize The size of icons to select.
* \return default images.
*/
static GtkImage *

9
gtk/throbber.c
View File

@ -30,12 +30,13 @@
struct nsgtk_throbber *nsgtk_throbber = NULL;
/**
* Creates the throbber using a PNG for each frame. The number of frames must
* be at least two. The first frame is the inactive frame, others are the
* active frames.
* Creates the throbber using a PNG for each frame.
*
* The number of frames must be at least two. The first frame is the
* inactive frame, others are the active frames.
*
* \param frames The number of frames. Must be at least two.
* \param ... Filenames of PNGs containing frames.
* \param frame_files Filenames of PNGs containing frames.
* \return true on success.
*/
bool nsgtk_throbber_initialise_from_png(const int frames, char** frame_files)

4
render/box.c
View File

@ -712,7 +712,7 @@ struct box *box_at_point(struct box *box, const int x, const int y,
* updated if box is nearer than existing nearest
* \param nr_xd distance to nearest text box found
* updated if box is nearer than existing nearest
* \param ny_yd distance to nearest text box found
* \param nr_yd distance to nearest text box found
* updated if box is nearer than existing nearest
* \return true if mouse point is inside box
*/
@ -784,7 +784,7 @@ static bool box_nearer_text_box(struct box *box, int bx, int by,
* updated if a descendant of box is nearer than old nearest
* \param nr_xd distance to nearest text box found
* updated if a descendant of box is nearer than old nearest
* \param ny_yd distance to nearest text box found
* \param nr_yd distance to nearest text box found
* updated if a descendant of box is nearer than old nearest
* \return true if mouse point is inside text_box
*/

8
render/box_construct.c
View File

@ -454,9 +454,9 @@ void convert_xml_to_box(struct box_construct_ctx *ctx)
*
* \param box Box to attach marker to
* \param title Current title attribute
* \param content Containing content
* \param ctx Box construction context
* \param parent Current block-level container
* \return True on success, false on memory exhaustion
* \return true on success, false on memory exhaustion
*/
static bool box_construct_marker(struct box *box, const char *title,
struct box_construct_ctx *ctx, struct box *parent)
@ -1921,9 +1921,9 @@ bool box_frameset(BOX_SPECIAL_PARAMS)
/**
* Destructor for content_html_frames, for <frame> elements
* Destructor for content_html_frames, for frame elements
*
* \param b The frame params being destroyed.
* \param f The frame params being destroyed.
* \return 0 to allow talloc to continue destroying the tree.
*/
static int box_frames_talloc_destructor(struct content_html_frames *f)

6
render/box_normalise.c
View File

@ -80,9 +80,9 @@ static bool box_normalise_inline_container(struct box *cont, html_content *c);
/**
* Ensure the box tree is correctly nested by adding and removing nodes.
*
* \param block box of type BLOCK, INLINE_BLOCK, or TABLE_CELL
* \param box_pool pool to allocate new boxes in
* \return true on success, false on memory exhaustion
* \param block box of type BLOCK, INLINE_BLOCK, or TABLE_CELL
* \param c content of boxes
* \return true on success, false on memory exhaustion
*
* The tree is modified to satisfy the following:
* \code

27
riscos/gui/throbber.h
View File

@ -82,14 +82,17 @@ bool ro_gui_throbber_get_dims(struct throbber *throbber,
/**
* Set or update the dimensions to be used by the throbber, in RO units.
* Set or update the dimensions to be used by the throbber in RO units
*
* If these are greater than the minimum required, the throbber will fill
* the extended space; if less, the call will fail.
*
* \param *throbber The throbber to update.
* \param width The desired width.
* \param height The desired height.
* \return true if size updated; else false.
* \param throbber The throbber to update.
* \param x0 top left of bounding box x coordinate
* \param y0 top left of bounding box y coordinate
* \param x1 bottom right of bounding box x coordinate
* \param y1 bottom right of bounding box y coordinate
* \return true if size updated; else false.
*/
bool ro_gui_throbber_set_extent(struct throbber *throbber,
@ -110,13 +113,13 @@ bool ro_gui_throbber_hide(struct throbber *throbber, bool hide);
/**
* Translate mouse data into an interactive help message for the throbber.
*
* \param *throbber The throbber to process.
* \param i The wimp icon under the pointer.
* \param *mouse The mouse position.
* \param *state The toolbar window state.
* \param buttons The mouse button state.
* \param **suffix Return a help token suffix, or "" for none.
* \return true if handled exclusively; else false.
* \param throbber The throbber to process.
* \param i The wimp icon under the pointer.
* \param screenpos The screen position.
* \param state The toolbar window state.
* \param buttons The mouse button state.
* \param suffix Return a help token suffix, or "" for none.
* \return true if handled exclusively; else false.
*/
bool ro_gui_throbber_help_suffix(struct throbber *throbber, wimp_i i,

2
riscos/theme.c
View File

@ -712,8 +712,6 @@ void ro_gui_theme_close(struct theme_descriptor *descriptor, bool list)
* Frees any unused theme descriptors.
*
* \param descriptor the theme_descriptor to free
* \param list whether to open all themes in the list
* \return whether the operation was successful
*/
void ro_gui_theme_free(struct theme_descriptor *descriptor)
{

4
riscos/window.c
View File

@ -998,7 +998,7 @@ static void gui_window_update_extent(struct gui_window *g)
* \param text new status text
*/
static void gui_window_set_status(struct gui_window *g, const char *text)
static void riscos_window_set_status(struct gui_window *g, const char *text)
{
if (g->status_bar)
ro_gui_status_bar_set_text(g->status_bar, text);
@ -5024,7 +5024,7 @@ static struct gui_window_table window_table = {
.set_title = gui_window_set_title,
.set_url = gui_window_set_url,
.set_icon = gui_window_set_icon,
.set_status = gui_window_set_status,
.set_status = riscos_window_set_status,
.set_pointer = gui_window_set_pointer,
.place_caret = gui_window_place_caret,
.remove_caret = gui_window_remove_caret,