summaryrefslogtreecommitdiff
path: root/desktop
diff options
context:
space:
mode:
authorMichael Drake <tlsa@netsurf-browser.org>2013-07-08 13:01:00 +0100
committerMichael Drake <tlsa@netsurf-browser.org>2013-07-08 13:01:00 +0100
commite8f2297d0fcfef6edfd024c838436b9c218d8aa9 (patch)
tree277d016d2320670e6d61ab662500768847ef7fd8 /desktop
parent7bd01a0e7504e0b44fdade4581e57cb00151566d (diff)
downloadnetsurf-e8f2297d0fcfef6edfd024c838436b9c218d8aa9.tar.gz
netsurf-e8f2297d0fcfef6edfd024c838436b9c218d8aa9.tar.bz2
Improve doc comments.
Diffstat (limited to 'desktop')
-rw-r--r--desktop/treeview.c14
1 files changed, 14 insertions, 0 deletions
diff --git a/desktop/treeview.c b/desktop/treeview.c
index 0e3880b42..ead92ec26 100644
--- a/desktop/treeview.c
+++ b/desktop/treeview.c
@@ -1405,6 +1405,8 @@ bool treeview_select_all(treeview *tree, struct rect *rect)
/**
* Commit a current selection drag, modifying the node's selection state.
+ *
+ * \param tree Treeview object to commit drag selection in
*/
static void treeview_commit_selection_drag(treeview *tree)
{
@@ -1428,6 +1430,10 @@ static void treeview_commit_selection_drag(treeview *tree)
/**
* Delete a selection.
+ *
+ * \param tree Treeview object to delete selected nodes from
+ * \param rect Updated to redraw rectangle
+ * \return true iff redraw required.
*/
static bool treeview_delete_selection(treeview *tree, struct rect *rect)
{
@@ -1458,6 +1464,7 @@ struct treeview_launch_walk_data {
int selected_depth;
treeview *tree;
};
+/** Treewalk node walk backward callback for tracking folder selection. */
static nserror treeview_node_launch_walk_bwd_cb(treeview_node *n, void *ctx,
bool *end)
{
@@ -1469,6 +1476,7 @@ static nserror treeview_node_launch_walk_bwd_cb(treeview_node *n, void *ctx,
return NSERROR_OK;
}
+/** Treewalk node walk forward callback for launching nodes. */
static nserror treeview_node_launch_walk_fwd_cb(treeview_node *n, void *ctx,
bool *skip_children, bool *end)
{
@@ -1490,6 +1498,12 @@ static nserror treeview_node_launch_walk_fwd_cb(treeview_node *n, void *ctx,
}
/**
* Launch a selection.
+ *
+ * \param tree Treeview object to launch selected nodes in
+ * \return NSERROR_OK on success, appropriate error otherwise
+ *
+ * Note: Selected entries are launched.
+ * Entries that are descendants of selected folders are also launched.
*/
static nserror treeview_launch_selection(treeview *tree)
{