summaryrefslogtreecommitdiff
path: root/render
diff options
context:
space:
mode:
authorVincent Sanders <vince@kyllikki.org>2014-11-08 12:35:11 +0000
committerVincent Sanders <vince@kyllikki.org>2014-11-08 12:35:11 +0000
commit8f64d5d223a6ccc60f04e815355c9d3f216a4410 (patch)
tree5ae4e823e45221cd6a92eead6fd5060c0430bec3 /render
parentf287379a7cca0717166119ecbf15b4e2dcdbfc56 (diff)
downloadnetsurf-8f64d5d223a6ccc60f04e815355c9d3f216a4410.tar.gz
netsurf-8f64d5d223a6ccc60f04e815355c9d3f216a4410.tar.bz2
Improve Doxygen documentation
Diffstat (limited to 'render')
-rw-r--r--render/search.c9
-rw-r--r--render/search.h31
2 files changed, 22 insertions, 18 deletions
diff --git a/render/search.c b/render/search.c
index f509f5890..7c2bd2def 100644
--- a/render/search.c
+++ b/render/search.c
@@ -268,9 +268,10 @@ static const char *find_pattern(const char *string, int s_len,
/**
* Add a new entry to the list of matches
*
- * \param start_idx offset of match start within textual representation
- * \param end_idx offset of match end
- * \return pointer to added entry, NULL iff failed
+ * \param start_idx Offset of match start within textual representation
+ * \param end_idx Offset of match end
+ * \param context The search context to add the entry to.
+ * \return Pointer to added entry, NULL iff failed.
*/
static struct list_entry *add_entry(unsigned start_idx, unsigned end_idx,
@@ -310,6 +311,7 @@ static struct list_entry *add_entry(unsigned start_idx, unsigned end_idx,
* \param p_len pattern length
* \param cur pointer to the current box
* \param case_sens whether to perform a case sensitive search
+ * \param context The search context to add the entry to.
* \return true on success, false on memory allocation failure
*/
static bool find_occurrences_html(const char *pattern, int p_len,
@@ -371,6 +373,7 @@ static bool find_occurrences_html(const char *pattern, int p_len,
* \param p_len pattern length
* \param c the content to be searched
* \param case_sens wheteher to perform a case sensitive search
+ * \param context The search context to add the entry to.
* \return true on success, false on memory allocation failure
*/
diff --git a/render/search.h b/render/search.h
index a8354e77e..79d1ee3d3 100644
--- a/render/search.h
+++ b/render/search.h
@@ -29,13 +29,12 @@ struct search_context;
/**
* create a search_context
*
- * \param c the content the search_context is connected to
- * \param type the content type of c
- * \param callbacks the callbacks to modify appearance according to results
- * \param p the pointer to send to the callbacks
- * \return true for success
+ * \param c The content the search_context is connected to
+ * \param type The content type of c
+ * \param context A context pointer passed to the provider routines.
+ * \return A new search context or NULL on error.
*/
-struct search_context * search_create_context(struct content *c,
+struct search_context *search_create_context(struct content *c,
content_type type, void *context);
/**
@@ -46,11 +45,12 @@ void search_destroy_context(struct search_context *context);
/**
* Begins/continues the search process
- * Note that this may be called many times for a single search.
*
- * \param bw the browser_window to search in
- * \param flags the flags forward/back etc
- * \param string the string to match
+ * \note that this may be called many times for a single search.
+ *
+ * \param context The search context in use.
+ * \param flags The flags forward/back etc
+ * \param string The string to match
*/
void search_step(struct search_context *context, search_flags_t flags,
const char * string);
@@ -65,11 +65,12 @@ void search_show_all(bool all, struct search_context *context);
* Determines whether any portion of the given text box should be
* selected because it matches the current search string.
*
- * \param bw browser window
- * \param start_offset byte offset within text of string to be checked
- * \param end_offset byte offset within text
- * \param start_idx byte offset within string of highlight start
- * \param end_idx byte offset of highlight end
+ * \param c The content to hilight within.
+ * \param start_offset byte offset within text of string to be checked
+ * \param end_offset byte offset within text
+ * \param start_idx byte offset within string of highlight start
+ * \param end_idx byte offset of highlight end
+ * \param context The search context to hilight entries from.
* \return true iff part of the box should be highlighted
*/
bool search_term_highlighted(struct content *c,