mirror of
https://github.com/netsurf-browser/netsurf
synced 2024-12-15 16:52:40 +03:00
Desktop doxygen fixes
This commit is contained in:
parent
9f0b252371
commit
7c4c73f1b0
@ -43,8 +43,8 @@ enum browser_mouse_state;
|
||||
*
|
||||
* This must be called before any other cookie_manager_* function.
|
||||
*
|
||||
* \param cw_t Callback table for core_window containing the treeview
|
||||
* \param cw The core_window in which the treeview is shown
|
||||
* \param cw_t Callback table for core_window containing the treeview
|
||||
* \param core_window_handle The core_window in which the treeview is shown
|
||||
* \return NSERROR_OK on success, appropriate error otherwise
|
||||
*/
|
||||
nserror cookie_manager_init(struct core_window_callback_table *cw_t,
|
||||
@ -79,10 +79,10 @@ void cookie_manager_remove(const struct cookie_data *data);
|
||||
/**
|
||||
* Redraw the cookies manager.
|
||||
*
|
||||
* \param x X coordinate to render treeview at
|
||||
* \param x Y coordinate to render treeview at
|
||||
* \param clip Current clip rectangle (wrt tree origin)
|
||||
* \param ctx Current redraw context
|
||||
* \param x X coordinate to render treeview at
|
||||
* \param y Y coordinate to render treeview at
|
||||
* \param clip Current clip rectangle (wrt tree origin)
|
||||
* \param ctx Current redraw context
|
||||
*/
|
||||
void cookie_manager_redraw(int x, int y, struct rect *clip,
|
||||
const struct redraw_context *ctx);
|
||||
|
@ -284,8 +284,8 @@ void browser_window_recalculate_iframes(struct browser_window *bw)
|
||||
/**
|
||||
* Create and open a frameset for a browser window.
|
||||
*
|
||||
* \param bw The browser window to create the frameset for
|
||||
* \param iframe The frameset to create
|
||||
* \param bw The browser window to create the frameset for
|
||||
* \param frameset The frameset to create
|
||||
*/
|
||||
|
||||
void browser_window_create_frameset(struct browser_window *bw,
|
||||
@ -638,7 +638,9 @@ void browser_window_recalculate_frameset(struct browser_window *bw)
|
||||
/**
|
||||
* Resize a browser window that is a frame.
|
||||
*
|
||||
* \param bw The browser window to resize
|
||||
* \param bw The browser window to resize
|
||||
* \param x The new width to set.
|
||||
* \param y The new height to set.
|
||||
*/
|
||||
|
||||
void browser_window_resize_frame(struct browser_window *bw, int x, int y)
|
||||
|
@ -245,7 +245,7 @@ static inline nserror global_history_get_parent_treeview_node(
|
||||
* Set a global history entry's data from the url_data.
|
||||
*
|
||||
* \param e Global history entry to set up
|
||||
* \param url_data Data associated with entry's URL
|
||||
* \param data Data associated with entry's URL
|
||||
* \return NSERROR_OK on success, appropriate error otherwise
|
||||
*/
|
||||
static nserror global_history_create_treeview_field_data(
|
||||
|
@ -39,8 +39,8 @@ enum browser_mouse_state;
|
||||
*
|
||||
* This must be called before any other global_history_* function.
|
||||
*
|
||||
* \param cw_t Callback table for core_window containing the treeview
|
||||
* \param cw The core_window in which the treeview is shown
|
||||
* \param cw_t Callback table for core_window containing the treeview.
|
||||
* \param core_window_handle The core_window in which the treeview is shown.
|
||||
* \return NSERROR_OK on success, appropriate error otherwise
|
||||
*/
|
||||
nserror global_history_init(struct core_window_callback_table *cw_t,
|
||||
@ -79,10 +79,10 @@ nserror global_history_export(const char *path, const char *title);
|
||||
/**
|
||||
* Redraw the global history.
|
||||
*
|
||||
* \param x X coordinate to render treeview at
|
||||
* \param x Y coordinate to render treeview at
|
||||
* \param clip Current clip rectangle (wrt tree origin)
|
||||
* \param ctx Current redraw context
|
||||
* \param x X coordinate to render treeview at
|
||||
* \param y Y coordinate to render treeview at
|
||||
* \param clip Current clip rectangle (wrt tree origin)
|
||||
* \param ctx Current redraw context
|
||||
*/
|
||||
void global_history_redraw(int x, int y, struct rect *clip,
|
||||
const struct redraw_context *ctx);
|
||||
|
@ -404,11 +404,11 @@ bool knockout_plot_flush(void)
|
||||
/**
|
||||
* Knockout a section of previous rendering
|
||||
*
|
||||
* \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
|
||||
* \param y1 the top edge of the removal box
|
||||
* \param box the parent box set to consider, or NULL for top level
|
||||
* \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
|
||||
* \param y1 The top edge of the removal box
|
||||
* \param owner The parent box set to consider, or NULL for top level
|
||||
*/
|
||||
void knockout_calculate(int x0, int y0, int x1, int y1, struct knockout_box *owner)
|
||||
{
|
||||
|
@ -41,6 +41,7 @@ nserror netsurf_register(struct netsurf_table *table);
|
||||
* Initialise netsurf core.
|
||||
*
|
||||
* @param messages path to translation mesage file.
|
||||
* @param store_path path to persistant storage.
|
||||
* @return NSERROR_OK on success or error code on faliure.
|
||||
*/
|
||||
nserror netsurf_init(const char *messages, const char *store_path);
|
||||
|
@ -176,11 +176,12 @@ static bool save_complete_save_buffer(save_complete_ctx *ctx,
|
||||
/**
|
||||
* Rewrite stylesheet \@import rules for save complete.
|
||||
*
|
||||
* \param source stylesheet source
|
||||
* \param size size of source
|
||||
* \param base url of stylesheet
|
||||
* \param osize updated with the size of the result
|
||||
* \return converted source, or NULL on out of memory
|
||||
* \param ctx Save complete context.
|
||||
* \param source stylesheet source.
|
||||
* \param size size of source.
|
||||
* \param base url of stylesheet.
|
||||
* \param osize updated with the size of the result.
|
||||
* \return converted source, or NULL on out of memory.
|
||||
*/
|
||||
|
||||
static char *save_complete_rewrite_stylesheet_urls(save_complete_ctx *ctx,
|
||||
|
@ -217,7 +217,7 @@ parse_providers(char *providersd,
|
||||
/**
|
||||
* create a url for a search provider and a term
|
||||
*
|
||||
* \param The provider to use.
|
||||
* \param provider The provider to use.
|
||||
* \param term The term being searched for.
|
||||
* \param url_out The resulting url.
|
||||
* \return NSERROR_OK on sucess or appropriate error code.
|
||||
|
@ -55,9 +55,9 @@ nserror sslcert_viewer_create_session_data(
|
||||
*
|
||||
* This iterates through the certificates, building a treeview.
|
||||
*
|
||||
* \param cw_t Callback table for cert viewer's core_window
|
||||
* \param cw The core_window in which the cert viewer is shown
|
||||
* \param ssl_d SSL certificate session data
|
||||
* \param cw_t Callback table for cert viewer's core_window
|
||||
* \param core_window_handle The core_window in which the cert viewer is shown
|
||||
* \param ssl_d SSL certificate session data
|
||||
* \return NSERROR_OK on success, appropriate error otherwise
|
||||
*/
|
||||
nserror sslcert_viewer_init(struct core_window_callback_table *cw_t,
|
||||
@ -95,7 +95,7 @@ nserror sslcert_viewer_accept(struct sslcert_session_data *ssl_d);
|
||||
*
|
||||
* \param ssl_d SSL certificate session data
|
||||
* \param x X coordinate to render treeview at
|
||||
* \param x Y coordinate to render treeview at
|
||||
* \param y Y coordinate to render treeview at
|
||||
* \param clip Current clip rectangle (wrt tree origin)
|
||||
* \param ctx Current redraw context
|
||||
*/
|
||||
|
@ -497,7 +497,7 @@ static bool textarea_set_caret_internal(struct textarea *ta, int caret_b)
|
||||
* \param ta Text area
|
||||
* \param b_start First character (inclusive) byte offset
|
||||
* \param b_end Last character (exclusive) byte offset
|
||||
* \parm force_redraw Redraw whether selection changed or not
|
||||
* \param force_redraw Redraw whether selection changed or not
|
||||
* \return true on success false otherwise
|
||||
*/
|
||||
static bool textarea_select(struct textarea *ta, int b_start, int b_end,
|
||||
|
@ -111,10 +111,11 @@ typedef struct textarea_setup {
|
||||
typedef void(*textarea_client_callback)(void *data, struct textarea_msg *msg);
|
||||
|
||||
/**
|
||||
* Create a text area
|
||||
* Create a text area.
|
||||
*
|
||||
* \param flags flags controlling the text area creation
|
||||
* \param setup textarea settings and style
|
||||
* \param redraw_callback will be called when textarea wants to redraw
|
||||
* \param callback will be called when textarea wants to redraw
|
||||
* \param data user specified data which will be passed to callbacks
|
||||
* \return Opaque handle for textarea or 0 on error
|
||||
*/
|
||||
@ -143,6 +144,7 @@ bool textarea_set_text(struct textarea *ta, const char *text);
|
||||
*
|
||||
* \param ta Text area
|
||||
* \param text UTF-8 text to set text area's contents to
|
||||
* \param text_length length of text.
|
||||
* \return true on success, false on memory exhaustion or if ta lacks caret
|
||||
*/
|
||||
bool textarea_drop_text(struct textarea *ta, const char *text,
|
||||
|
Loading…
Reference in New Issue
Block a user