Change recent code comments to Doxygen style

diff --git a/src/collect-io.c b/src/collect-io.c
index 62326d0..a58ac7f 100644 (file)
--- a/src/collect-io.c
+++ b/src/collect-io.c
@@ -978,14 +978,14 @@ static gint collection_manager_sort_cb(gconstpointer a, gconstpointer b)
 
        return g_strcmp0(char_a, char_b);
 }
-
-/* Creates sorted list of collections
- * Inputs: none
- * Outputs: list of type gchar
- *                     sorted list of collections names excluding extension
- *                     sorted list of collections names including extension
- *                     sorted list of collection paths
- * Return: none
+ 
+/**
+ * @brief Creates sorted list of collections
+ * @param[out] names_exc sorted list of collections names excluding extension
+ * @param[out] names_inc sorted list of collections names including extension
+ * @param[out] paths sorted list of collection paths
+ * 
+ * Lists of type gchar.
  * Used lists must be freed with string_list_free()
  */
 void collect_manager_list(GList **names_exc, GList **names_inc, GList **paths)

diff --git a/src/collect.c b/src/collect.c
index 3d97e4c..198a33a 100644 (file)
--- a/src/collect.c
+++ b/src/collect.c
@@ -44,12 +44,22 @@
 #define COLLECT_DEF_WIDTH 440
 #define COLLECT_DEF_HEIGHT 450
 
-/* list of paths to collections */
+/**
+ *  list of paths to collections */
 
-/* List of currently open Collections*/
-static GList *collection_list = NULL; /* type CollectionData */
-/* List of currently open Collection windows*/
-static GList *collection_window_list = NULL; /* type CollectWindow */
+/**
+ * @brief  List of currently open Collections.
+ * 
+ * Type ::_CollectionData 
+ */
+static GList *collection_list = NULL;
+
+/**
+ * @brief  List of currently open Collection windows.
+ * 
+ * Type ::_CollectWindow
+ */
+static GList *collection_window_list = NULL;
 
 static void collection_window_get_geometry(CollectWindow *cw);
 static void collection_window_refresh(CollectWindow *cw);
@@ -311,11 +321,11 @@ CollectWindow *collection_window_find_by_path(const gchar *path)
        return NULL;
 }
 
-/* Checks string for existence of Collection.
- * The parameter is the filename,
- * with or without extension of any collection
- *
- * Returns: full pathname if found or NULL
+/**
+ * @brief Checks string for existence of Collection.
+ * @param[in] param Filename, with or without extension of any collection
+ * @returns full pathname if found or NULL
+ * 
  * Return value must be freed with g_free()
  */
 gchar *collection_path(gchar *param)
@@ -343,11 +353,12 @@ gchar *collection_path(gchar *param)
        return path;
 }
 
-/* Checks input string for existence of Collection.
- * The parameter is the filename
- * with or without extension of any collection
+/**
+ * @brief Checks input string for existence of Collection.
+ * @param[in] param Filename with or without extension of any collection
+ * @returns TRUE if found
+ * 
  * 
- * Returns TRUE if found
  */
 gboolean is_collection(gchar *param)
 {

diff --git a/src/dupe.c b/src/dupe.c
index e02feca..f52b560 100644 (file)
--- a/src/dupe.c
+++ b/src/dupe.c
@@ -2309,10 +2309,12 @@ static GList *dupe_window_get_fd_list(DupeWindow *dw)
        return list;
 }
 
-/* Add file selection list to a collection
- * Called from a right-click menu
- * Inputs:
- * data: index to the collection list menu item selected, or -1 for new collection
+/**
+ * @brief Add file selection list to a collection
+ * @param[in] widget 
+ * @param[in] data Index to the collection list menu item selected, or -1 for new collection
+ * 
+ * 
  */
 static void dupe_pop_menu_collections_cb(GtkWidget *widget, gpointer data)
 {

diff --git a/src/img-view.c b/src/img-view.c
index 52a59c1..9d7646f 100644 (file)
--- a/src/img-view.c
+++ b/src/img-view.c
@@ -1254,10 +1254,12 @@ static GList *view_window_get_fd_list(ViewWindow *vw)
        return list;
 }
 
-/* Add file selection list to a collection
- * Called from a right-click submenu
- * Inputs:
- * data: index to the collection list menu item selected, or -1 for new collection
+/**
+ * @brief Add file selection list to a collection
+ * @param[in] widget 
+ * @param[in] data Index to the collection list menu item selected, or -1 for new collection
+ * 
+ * 
  */
 static void image_pop_menu_collections_cb(GtkWidget *widget, gpointer data)
 {

diff --git a/src/layout_image.c b/src/layout_image.c
index 5db6599..c6377cb 100644 (file)
--- a/src/layout_image.c
+++ b/src/layout_image.c
@@ -642,10 +642,12 @@ static GList *layout_image_get_fd_list(LayoutWindow *lw)
        return list;
 }
 
-/* Add file selection list to a collection
- * Called from a right-click submenu
- * Inputs:
- * data: index to the collection list menu item selected, or -1 for new collection
+/**
+ * @brief Add file selection list to a collection
+ * @param[in] widget 
+ * @param[in] data Index to the collection list menu item selected, or -1 for new collection
+ * 
+ * 
  */
 static void layout_pop_menu_collections_cb(GtkWidget *widget, gpointer data)
 {

diff --git a/src/menu.c b/src/menu.c
index dbbb851..d5a0c7a 100644 (file)
--- a/src/menu.c
+++ b/src/menu.c
@@ -388,9 +388,14 @@ GtkWidget *submenu_add_alter(GtkWidget *menu, GCallback func, gpointer data)
  *-----------------------------------------------------------------------------
  */
 
-/* Add submenu consisting of "New collection", and list of existing collections
- * to a right-click menu.
- * Used by image windows
+/**
+ * @brief Add submenu consisting of "New collection", and list of existing collections to a right-click menu.
+ * @param[in] menu 
+ * @param[in] func 
+ * @param[in] collection_list Type gchar
+ * @param[in] data 
+ * 
+ *  Used by all image windows
  */
 static void add_collection_list(GtkWidget *menu, GCallback func,
                                                                GList *collection_list, gpointer data)
@@ -438,11 +443,12 @@ GtkWidget *submenu_add_collections(GtkWidget *menu, GtkWidget **menu_item,
        return submenu;
 }
 
-/* Add file selection list to a collection
- * Called from a right-click submenu
- * Inputs:
- * selection_list: GList of FileData
- * data: index to the collection list menu item selected, or -1 for new collection
+/**
+ * @brief Add file selection list to a collection
+ * @param[in] selection_list Selection list of ::_FileData
+ * @param[in] data Index to the collection list menu item selected, or -1 for new collection
+ * 
+ * 
  */
 void pop_menu_collections(GList *selection_list, gpointer data)
 {

diff --git a/src/pan-view/pan-view.c b/src/pan-view/pan-view.c
index 842580e..5acbc2c 100644 (file)
--- a/src/pan-view/pan-view.c
+++ b/src/pan-view/pan-view.c
@@ -2196,10 +2196,12 @@ static GList *pan_view_get_fd_list(PanWindow *pw)
        return list;
 }
 
-/* Add file selection list to a collection
- * Called from a right-click submenu
- * Inputs:
- * data: index to the collection list menu item selected, or -1 for new collection
+/**
+ * @brief Add file selection list to a collection
+ * @param[in] widget 
+ * @param[in] data Index to the collection list menu item selected, or -1 for new collection
+ * 
+ * 
  */
 static void pan_pop_menu_collections_cb(GtkWidget *widget, gpointer data)
 {

diff --git a/src/search.c b/src/search.c
index da19e91..b78b3be 100644 (file)
--- a/src/search.c
+++ b/src/search.c
@@ -1030,10 +1030,12 @@ static void search_result_menu_destroy_cb(GtkWidget *widget, gpointer data)
        filelist_free(editmenu_fd_list);
 }
 
-/* Add file selection list to a collection
- * Called from a right-click submenu
- * Inputs:
- * data: index to the collection list menu item selected, or -1 for new collection
+/**
+ * @brief Add file selection list to a collection
+ * @param[in] widget 
+ * @param[in] data Index to the collection list menu item selected, or -1 for new collection
+ * 
+ * 
  */
 static void search_pop_menu_collections_cb(GtkWidget *widget, gpointer data)
 {

diff --git a/src/view_file/view_file.c b/src/view_file/view_file.c
index 43315b8..810baf5 100644 (file)
--- a/src/view_file/view_file.c
+++ b/src/view_file/view_file.c
@@ -504,10 +504,12 @@ static void vf_popup_destroy_cb(GtkWidget *widget, gpointer data)
        vf->editmenu_fd_list = NULL;
 }
 
-/* Add file selection list to a collection
- * Called from a right-click menu
- * Inputs:
- * data: index to the collection list menu item selected, or -1 for new collection
+/**
+ * @brief Add file selection list to a collection
+ * @param[in] widget 
+ * @param[in] data Index to the collection list menu item selected, or -1 for new collection
+ * 
+ * 
  */
 static void vf_pop_menu_collections_cb(GtkWidget *widget, gpointer data)
 {