eukara
/
WebSurf
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doxgen warning fixes in riscos frontend.

This commit is contained in:
Vincent Sanders 2014-11-12 22:36:11 +00:00
parent 1a7d00076d
commit e8277f2954
10 changed files with 61 additions and 53 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
render/layout.c
View File

@ -140,10 +140,10 @@ static void layout_compute_offsets(struct box *box,
/**
* Calculate positions of boxes in a document.
*
* \param doc content of type CONTENT_HTML
* \param width available width
* \param height available height
* \return true on success, false on memory exhaustion
* \param content content of type CONTENT_HTML
* \param width available width
* \param height available height
* \return true on success, false on memory exhaustion
*/
bool layout_document(html_content *content, int width, int height)
@ -688,7 +688,8 @@ bool layout_block_context(struct box *block, int viewport_height,
/**
* Calculate minimum and maximum width of a block.
*
* \param block box of type BLOCK, INLINE_BLOCK, or TABLE_CELL
* \param block box of type BLOCK, INLINE_BLOCK, or TABLE_CELL
* \param font_func font functions
* \post block->min_width and block->max_width filled in,
* 0 <= block->min_width <= block->max_width
*/
@ -775,7 +776,7 @@ void layout_minmax_block(struct box *block,
block->flags |= HAS_HEIGHT;
} else if (block->flags & IFRAME) {
/** TODO: do we need to know the min/max width of the iframe's
/** \todo do we need to know the min/max width of the iframe's
* content? */
block->flags |= HAS_HEIGHT;
} else {
@ -1611,9 +1612,9 @@ void layout_float_find_dimensions(int available_width,
* \param min_width updated to min-width, may be NULL
* \param max_height updated to max-height, may be NULL
* \param min_height updated to min-height, may be NULL
* \param margin[4] filled with margins, may be NULL
* \param padding[4] filled with paddings, may be NULL
* \param border[4] filled with border widths, may be NULL
* \param margin filled with margins, may be NULL
* \param padding filled with paddings, may be NULL
* \param border filled with border widths, may be NULL
*/
void layout_find_dimensions(int available_width, int viewport_height,
@ -2090,7 +2091,7 @@ void find_sides(struct box *fl, int y0, int y1,
/**
* Layout lines of text or inline boxes with floats.
*
* \param box inline container
* \param inline_container inline container box
* \param width horizontal space available
* \param cont ancestor box which defines horizontal space, for floats
* \param cx box position relative to cont
@ -2163,7 +2164,9 @@ bool layout_inline_container(struct box *inline_container, int width,
/**
* Calculate minimum and maximum width of an inline container.
*
* \param inline_container box of type INLINE_CONTAINER
* \param inline_container box of type INLINE_CONTAINER
* \param[out] has_height set to true if container has height
* \param font_func Font functions.
* \post inline_container->min_width and inline_container->max_width filled in,
* 0 <= inline_container->min_width <= inline_container->max_width
*/
@ -3044,11 +3047,12 @@ bool layout_line(struct box *first, int *width, int *y,
/**
* Calculate minimum and maximum width of a line.
*
* \param first a box in an inline container
* \param line_min updated to minimum width of line starting at first
* \param line_max updated to maximum width of line starting at first
* \param first_line true iff this is the first line in the inline container
* \param line_has_height updated to true or false, depending on line
* \param first a box in an inline container
* \param line_min updated to minimum width of line starting at first
* \param line_max updated to maximum width of line starting at first
* \param first_line true iff this is the first line in the inline container
* \param line_has_height updated to true or false, depending on line
* \param font_func Font functions.
* \return first box in next line, or 0 if no more lines
* \post 0 <= *line_min <= *line_max
*/
@ -3937,7 +3941,7 @@ bool layout_table(struct box *table, int available_width,
/* Table height is either the height of the contents, or specified
* height if greater */
table_height = max(table_height, min_height);
/** \TODO distribute spare height over the row groups / rows / cells */
/** \todo distribute spare height over the row groups / rows / cells */
/* perform vertical alignment */
for (row_group = table->children; row_group;
@ -4009,7 +4013,8 @@ bool layout_table(struct box *table, int available_width,
/**
* Calculate minimum and maximum width of a table.
*
* \param table box of type TABLE
* \param table box of type TABLE
* \param font_func Font functions
* \post table->min_width and table->max_width filled in,
* 0 <= table->min_width <= table->max_width
*/
@ -4202,13 +4207,13 @@ void layout_move_children(struct box *box, int x, int y)
/**
* Determine width of margin, borders, and padding on one side of a box.
*
* \param style style to measure
* \param size side of box to measure
* \param margin whether margin width is required
* \param border whether border width is required
* \param padding whether padding width is required
* \param fixed increased by sum of fixed margin, border, and padding
* \param frac increased by sum of fractional margin and padding
* \param style style to measure
* \param side side of box to measure
* \param margin whether margin width is required
* \param border whether border width is required
* \param padding whether padding width is required
* \param fixed increased by sum of fixed margin, border, and padding
* \param frac increased by sum of fractional margin and padding
*/
void calculate_mbp_width(const css_computed_style *style, unsigned int side,

3
riscos/gui/button_bar.h
View File

@ -144,7 +144,8 @@ struct button_bar *ro_gui_button_bar_create(struct theme_descriptor *theme,
*
* \param target The target button bar.
* \param source The source button bar.
* \param refresh The refresh callback
* \param refresh The refresh callback.
* \param client_data context passed to the refresh callback
* \return true if successful; else false.
*/

2
riscos/gui/status_bar.c
View File

@ -247,7 +247,7 @@ bool ro_gui_status_bar_get_visible(struct status_bar *sb)
/**
* Set the value of the progress bar
*
* \param pb the status bar to set the progress of
* \param sb the status bar to set the progress of
* \param value the value to use
*/
void ro_gui_status_bar_set_progress_value(struct status_bar *sb,

11
riscos/iconbar.c
View File

@ -187,11 +187,12 @@ void ro_gui_iconbar_menu_warning(wimp_w w, wimp_i i, wimp_menu *menu,
/**
* Handle selections from the iconbar menu
*
* \param w The window owning the menu.
* \param i The icon owning the menu.
* \param *selection The wimp menu selection data.
* \param action The selected menu action.
* \return true if action accepted; else false.
* \param w The window owning the menu.
* \param i The icon owning the menu.
* \param menu The wimp menu
* \param selection The wimp menu selection data.
* \param action The selected menu action.
* \return true if action accepted; else false.
*/
bool ro_gui_iconbar_menu_select(wimp_w w, wimp_i i, wimp_menu *menu,

4
riscos/image.c
View File

@ -100,7 +100,7 @@ bool image_redraw(osspriteop_area *area, int x, int y, int req_width,
/**
* Plot an image at the given coordinates using tinct
*
* \param area The sprite area containing the sprite
* \param header The sprite header
* \param x Left edge of sprite
* \param y Top edge of sprite
* \param req_width The requested width of the sprite
@ -154,7 +154,7 @@ bool image_redraw_tinct(osspriteop_id header, int x, int y,
/**
* Plot an image at the given coordinates using os_spriteop
*
* \param area The sprite area containing the sprite
* \param header The sprite header
* \param x Left edge of sprite
* \param y Top edge of sprite
* \param req_width The requested width of the sprite

8
riscos/menus.c
View File

@ -510,10 +510,8 @@ void ro_gui_menu_refresh(wimp_menu *menu)
/**
* Creates a wimp_menu and adds it to the list to handle actions for.
*
* \param *menu The data to create the menu with
* \param *callbacks A callback table for the menu (NULL if to be
* handled in the 'old-fashined way' by menus.c).
* \return The menu created, or NULL on failure
* \param menu The data to create the menu with
* \return The menu created, or NULL on failure
*/
wimp_menu *ro_gui_menu_define_menu(const struct ns_menu *menu)
{
@ -807,7 +805,7 @@ menu_action ro_gui_menu_find_action(wimp_menu *menu, wimp_menu_entry *menu_entry
*
* \param menu the menu containing the action
* \param action the action to tick/untick
* \param ticked whether to set the item as ticked
* \param shaded whether to set the item as shaded
*/
void ro_gui_menu_set_entry_shaded(wimp_menu *menu, menu_action action,
bool shaded)

3
riscos/message.c
View File

@ -182,7 +182,8 @@ struct active_message *ro_message_add(unsigned int message_code,
/**
* Attempts to route a message.
*
* \param message the message to attempt to route
* \param event wimp event
* \param message the message to attempt to route
* \return true if message was routed, false otherwise
*/
bool ro_message_handle_message(wimp_event_no event, wimp_message *message)

6
riscos/save.c
View File

@ -799,9 +799,9 @@ void ro_gui_save_datasave_ack(wimp_message *message)
/**
* Does the actual saving
*
* \param c content to save (or NULL for other)
* \param path path to save as
* \param force_overwrite true iff required to overwrite without prompting
* \param h handle to content to save (or NULL for other)
* \param path path to save as
* \param force_overwrite true iff required to overwrite without prompting
* \return true on success,
* false on (i) error and error reported
* or (ii) deferred awaiting user confirmation

6
riscos/url_suggest.c
View File

@ -53,7 +53,7 @@ wimp_menu *ro_gui_url_suggest_menu = (wimp_menu *) &url_suggest_menu_block;
* Initialise the URL suggestion menu. This MUST be called before anything
* tries to use the URL menu.
*
* /return true if initialisation was OK; else false.
* \return true if initialisation was OK; else false.
*/
bool ro_gui_url_suggest_init(void)
@ -72,10 +72,10 @@ bool ro_gui_url_suggest_init(void)
/**
* Check if there is a URL suggestion menu available for use.
*
* \TODO -- Ideally this should be able to decide if there's a menu
* \todo Ideally this should be able to decide if there's a menu
* available without actually having to build it all.
*
* /return true if the menu has entries; else false.
* \return true if the menu has entries; else false.
*/
bool ro_gui_url_suggest_get_menu_available(void)

16
riscos/wimp.c
View File

@ -380,9 +380,10 @@ void ro_gui_set_icon_integer(wimp_w w, wimp_i i, int value)
/**
* Set the contents of an icon to a number.
*
* \param w window handle
* \param i icon handle
* \param value value
* \param w window handle
* \param i icon handle
* \param value value to use in icon.
* \param decimal_places The number of decimal places to use.
*/
void ro_gui_set_icon_decimal(wimp_w w, wimp_i i, int value, int decimal_places)
{
@ -414,9 +415,10 @@ void ro_gui_set_icon_decimal(wimp_w w, wimp_i i, int value, int decimal_places)
/**
* Get the contents of an icon as a number.
*
* \param w window handle
* \param i icon handle
* \param value value
* \param w window handle
* \param i icon handle
* \param decimal_places number of places to show.
* \return value used.
*/
int ro_gui_get_icon_decimal(wimp_w w, wimp_i i, int decimal_places)
{
@ -727,7 +729,7 @@ void ro_gui_set_window_title(wimp_w w, const char *text)
/**
* Places the caret in the first available icon
*
* \w the window to place the caret in
* \param w the window to place the caret in
* \return true if the caret was placed, false otherwise
*/
bool ro_gui_set_caret_first(wimp_w w)