From d6ee11de9365d87fe3e9e4ae94569c8b42136eb3 Mon Sep 17 00:00:00 2001 From: Michael Drake Date: Tue, 18 Jun 2013 17:22:56 +0100 Subject: [PATCH] Add documentation comments. --- desktop/global_history.h | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) diff --git a/desktop/global_history.h b/desktop/global_history.h index 960eb1e7a..7e2376b1d 100644 --- a/desktop/global_history.h +++ b/desktop/global_history.h @@ -23,15 +23,54 @@ #include "desktop/core_window.h" + +/** + * Initialise the global history. + * + * This iterates through the URL database, generating the global history data, + * and creates a treeview. + * + * 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 + * \return NSERROR_OK on success, appropriate error otherwise + */ nserror global_history_init(struct core_window_callback_table *cw_t, void *core_window_handle); +/** + * Finalise the global history. + * + * This destroys the global history treeview and the global history module's + * internal data. After calling this if global history is required again, + * global_history_init must be called. + * + * \param cw_t Callback table for core_window containing the treeview + * \param cw The core_window in which the treeview is shown + * \return NSERROR_OK on success, appropriate error otherwise + */ nserror global_history_fini(struct core_window_callback_table *cw_t, void *core_window_handle); +/** + * 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 + */ void global_history_redraw(int x, int y, struct rect *clip, const struct redraw_context *ctx); +/** + * Handles all kinds of mouse action + * + * \param mouse The current mouse state + * \param x X coordinate + * \param y Y coordinate + */ void global_history_mouse_action(browser_mouse_state mouse, int x, int y); #endif