From f287379a7cca0717166119ecbf15b4e2dcdbfc56 Mon Sep 17 00:00:00 2001
From: Vincent Sanders <vince@kyllikki.org>
Date: Sat, 8 Nov 2014 11:38:20 +0000
Subject: Fix several doxygen issues

---
 desktop/gui_misc.h |  7 ++++++-
 desktop/hotlist.c  | 17 +++++++++--------
 desktop/hotlist.h  | 14 +++++++-------
 3 files changed, 22 insertions(+), 16 deletions(-)

(limited to 'desktop')

diff --git a/desktop/gui_misc.h b/desktop/gui_misc.h
index 8005006c7..4664fc9dd 100644
--- a/desktop/gui_misc.h
+++ b/desktop/gui_misc.h
@@ -70,7 +70,12 @@ struct gui_browser_table {
 	nserror (*launch_url)(struct nsurl *url);
 
 	/**
-	 * verify certificate
+	 * Prompt the user to verify a certificate with issuse.
+	 *
+	 * \param url The URL being verified.
+	 * \param certs The certificate to be verified
+	 * \param num The number of certificates to be verified.
+	 * \param cb Callback upon user decision.
 	 */
 	void (*cert_verify)(struct nsurl *url, const struct ssl_cert_info *certs, unsigned long num, nserror (*cb)(bool proceed, void *pw), void *cbpw);
 
diff --git a/desktop/hotlist.c b/desktop/hotlist.c
index a5b86b581..38c8827bd 100644
--- a/desktop/hotlist.c
+++ b/desktop/hotlist.c
@@ -71,9 +71,9 @@ struct hotlist_entry {
 /**
  * Set a hotlist entry's data from the url_data.
  *
- * \param e		hotlist entry to set up
- * \param url_data	Data associated with entry's URL
- * \return NSERROR_OK on success, appropriate error otherwise
+ * \param e    hotlist entry to set up.
+ * \param data Data associated with entry's URL.
+ * \return NSERROR_OK on success, appropriate error otherwise.
  */
 static nserror hotlist_create_treeview_field_visits_data(
 		struct hotlist_entry *e, const struct url_data *data)
@@ -126,9 +126,9 @@ static nserror hotlist_create_treeview_field_visits_data(
 /**
  * Set a hotlist entry's data from the url_data.
  *
- * \param e		hotlist entry to set up
- * \param title		Title for entry, or NULL if using title from data
- * \param url_data	Data associated with entry's URL
+ * \param e     hotlist entry to set up
+ * \param title Title for entry, or NULL if using title from data
+ * \param data  Data associated with entry's URL
  * \return NSERROR_OK on success, appropriate error otherwise
  */
 static nserror hotlist_create_treeview_field_data(
@@ -320,6 +320,7 @@ static nserror hotlist_add_entry_internal(nsurl *url, const char *title,
  * \param relation	Existing node to insert as relation of, or NULL
  * \param rel		Folder's relationship to relation
  * \param folder	Updated to new hotlist folder data
+ * \param default_folder Add to teh default folder.
  * \return NSERROR_OK on success, or appropriate error otherwise
  */
 static nserror hotlist_add_folder_internal(
@@ -601,8 +602,8 @@ static nserror hotlist_load_directory_cb(dom_node *node, void *ctx);
 /**
  * Parse a directory represented as a ul.
  *
- * \param  ul		DOM node for parsed ul
- * \param  directory	directory to add this directory to
+ * \param ul DOM node for parsed ul.
+ * \param ctx The hotlist context.
  * \return NSERROR_OK on success, or appropriate error otherwise
  */
 static nserror hotlist_load_directory(dom_node *ul, hotlist_load_ctx *ctx)
diff --git a/desktop/hotlist.h b/desktop/hotlist.h
index 69caa01d9..933f30b42 100644
--- a/desktop/hotlist.h
+++ b/desktop/hotlist.h
@@ -39,9 +39,9 @@ enum browser_mouse_state;
  *
  * This must be called before any other hotlist_* function.
  *
- * \param cw_t		Callback table for core_window containing the treeview
- * \param cw		The core_window in which the treeview is shown
- * \param path		The path to hotlist file to load
+ * \param cw_t Callback table for core_window containing the treeview
+ * \param core_window_handle The handle in which the treeview is shown
+ * \param path The path to hotlist file to load
  * \return NSERROR_OK on success, appropriate error otherwise
  */
 nserror hotlist_init(struct core_window_callback_table *cw_t,
@@ -103,14 +103,14 @@ nserror hotlist_add_entry(struct nsurl *url, const char *title, bool at_y, int y
 /**
  * Add a folder to the hotlist.
  *
- * \param url		Title for folder being added, or NULL
- * \param at_y		Iff true, insert at y-offest
- * \param y		Y-offset in px from top of hotlist.  Ignored if (!at_y).
+ * \param title Title for folder being added, or NULL
+ * \param at_y Iff true, insert at y-offest
+ * \param y Y-offset in px from top of hotlist.  Ignored if (!at_y).
  * \return NSERROR_OK on success, appropriate error otherwise
  */
 nserror hotlist_add_folder(const char *title, bool at_y, int y);
 
-/*
+/**
  * Save hotlist to file
  *
  * \param path		The path to save hotlist to
-- 
cgit v1.2.3