Mercurial > hg > forks > geeqie
changeset 2583:6e92c0ad76f2
Change recent code comments to Doxygen style
| author | Colin Clark <colin.clark@cclark.uk> |
|---|---|
| date | Sun, 20 Aug 2017 11:20:48 +0100 |
| parents | 03014a1eb7e7 |
| children | f1276158f9a5 |
| files | src/collect-io.c src/collect.c src/dupe.c src/img-view.c src/layout_image.c src/menu.c src/pan-view/pan-view.c src/search.c src/view_file/view_file.c |
| diffstat | 9 files changed, 83 insertions(+), 54 deletions(-) [+] |
line wrap: on
line diff
--- a/src/collect-io.c Fri Aug 18 14:25:36 2017 +0100 +++ b/src/collect-io.c Sun Aug 20 11:20:48 2017 +0100 @@ -978,14 +978,14 @@ 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)
--- a/src/collect.c Fri Aug 18 14:25:36 2017 +0100 +++ b/src/collect.c Sun Aug 20 11:20:48 2017 +0100 @@ -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 @@ 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 @@ 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) {
--- a/src/dupe.c Fri Aug 18 14:25:36 2017 +0100 +++ b/src/dupe.c Sun Aug 20 11:20:48 2017 +0100 @@ -2309,10 +2309,12 @@ 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) {
--- a/src/img-view.c Fri Aug 18 14:25:36 2017 +0100 +++ b/src/img-view.c Sun Aug 20 11:20:48 2017 +0100 @@ -1254,10 +1254,12 @@ 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) {
--- a/src/layout_image.c Fri Aug 18 14:25:36 2017 +0100 +++ b/src/layout_image.c Sun Aug 20 11:20:48 2017 +0100 @@ -642,10 +642,12 @@ 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) {
--- a/src/menu.c Fri Aug 18 14:25:36 2017 +0100 +++ b/src/menu.c Sun Aug 20 11:20:48 2017 +0100 @@ -388,9 +388,14 @@ *----------------------------------------------------------------------------- */ -/* 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 @@ 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) {
--- a/src/pan-view/pan-view.c Fri Aug 18 14:25:36 2017 +0100 +++ b/src/pan-view/pan-view.c Sun Aug 20 11:20:48 2017 +0100 @@ -2196,10 +2196,12 @@ 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) {
--- a/src/search.c Fri Aug 18 14:25:36 2017 +0100 +++ b/src/search.c Sun Aug 20 11:20:48 2017 +0100 @@ -1030,10 +1030,12 @@ 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) {
--- a/src/view_file/view_file.c Fri Aug 18 14:25:36 2017 +0100 +++ b/src/view_file/view_file.c Sun Aug 20 11:20:48 2017 +0100 @@ -504,10 +504,12 @@ 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) {