From: Colin Clark Date: Wed, 5 May 2021 12:06:17 +0000 (+0100) Subject: Convert TODOs and FIXMEs to Doxygen style X-Git-Tag: v1.7~114 X-Git-Url: http://geeqie.org/cgi-bin/gitweb.cgi?p=geeqie.git;a=commitdiff_plain;h=84d758f0a1aef90b4890538e952d37b00542aef7 Convert TODOs and FIXMEs to Doxygen style All TODOs and FIXMEs will appear in the Related Pages Todo list. --- diff --git a/doxygen.conf b/doxygen.conf index 2560b46f..e4d2b2e4 100644 --- a/doxygen.conf +++ b/doxygen.conf @@ -238,7 +238,7 @@ TAB_SIZE = 8 # "Side Effects:". You can put \n's in the value part of an alias to insert # newlines. -ALIASES = +ALIASES += FIXME="@todo" # This tag can be used to specify a number of word-keyword mappings (TCL only). # A mapping has the form "name=value". For example adding "class=itcl::class" diff --git a/src/advanced_exif.c b/src/advanced_exif.c index c895dc54..541936bb 100644 --- a/src/advanced_exif.c +++ b/src/advanced_exif.c @@ -32,7 +32,7 @@ #include "window.h" #include "dnd.h" -/* FIXME: not needed when bar_exif.c is improved */ +/** @FIXME not needed when bar_exif.c is improved */ #include "bar_exif.h" #include diff --git a/src/bar.c b/src/bar.c index 239cc568..6fd0ee64 100644 --- a/src/bar.c +++ b/src/bar.c @@ -660,8 +660,8 @@ static void bar_destroy(GtkWidget *widget, gpointer data) } #ifdef HAVE_LIBCHAMPLAIN_GTK -/* - FIXME: this is an ugly hack that works around this bug: +/** + @FIXME this is an ugly hack that works around this bug: https://bugzilla.gnome.org/show_bug.cgi?id=590692 http://bugzilla.openedhand.com/show_bug.cgi?id=1751 it should be removed as soon as a better solution exists @@ -767,7 +767,7 @@ GtkWidget *bar_update_from_config(GtkWidget *bar, const gchar **attribute_names, } #if !GTK_CHECK_VERSION(3,0,0) -/* FIXME: In bar_size_allocate() the width obained is the allocated width. In GTK2 this +/** @FIXME In bar_size_allocate() the width obtained is the allocated width. In GTK2 this * is the actual width. In GTK3 it is the *minimum* width. * This results in the info sidebar being able to increase, but not * decrease. There does not seem to be a way in GTK3 to get the actual width of @@ -798,7 +798,8 @@ GtkWidget *bar_pane_expander_title(const gchar *title) GtkWidget *widget = gtk_label_new(title); pref_label_bold(widget, TRUE, FALSE); - //gtk_label_set_ellipsize(GTK_LABEL(widget), PANGO_ELLIPSIZE_END); //FIXME: do not work + //gtk_label_set_ellipsize(GTK_LABEL(widget), PANGO_ELLIPSIZE_END); + /** @FIXME do not work */ return widget; } diff --git a/src/bar_exif.c b/src/bar_exif.c index 5d1c2a55..fdc6271e 100644 --- a/src/bar_exif.c +++ b/src/bar_exif.c @@ -409,7 +409,7 @@ static void bar_pane_exif_dnd_receive(GtkWidget *pane, GdkDragContext *context, break; default: - /* FIXME: this needs a check for valid exif keys */ + /** @FIXME this needs a check for valid exif keys */ new_entry = bar_pane_exif_add_entry(ped, (gchar *)gtk_selection_data_get_data(selection_data), NULL, TRUE, FALSE); break; } diff --git a/src/bar_histogram.c b/src/bar_histogram.c index 4e51941e..58af06ca 100644 --- a/src/bar_histogram.c +++ b/src/bar_histogram.c @@ -66,9 +66,9 @@ static void bar_pane_histogram_update(PaneHistogramData *phd) if (!phd->histogram_width || !phd->histogram_height || !phd->fd) return; - /* histmap_get is relatively expensive, run it only when we really need it + /** histmap_get is relatively expensive, run it only when we really need it and with lower priority than pixbuf_renderer - FIXME: this does not work for fullscreen*/ + @FIXME this does not work for fullscreen */ if (gtk_widget_is_drawable(phd->drawing_area)) { if (!phd->idle_id) diff --git a/src/collect-dlg.c b/src/collect-dlg.c index 464002f0..eae8107a 100644 --- a/src/collect-dlg.c +++ b/src/collect-dlg.c @@ -111,7 +111,7 @@ static void collection_save_cb(FileDialog *fd, gpointer data) path = fd->dest_path; - /* FIXME: utf8 */ + /** @FIXME utf8 */ if (!file_extension_match(path, GQ_COLLECTION_EXT)) { gchar *buf; diff --git a/src/collect-io.c b/src/collect-io.c index 29110e7a..464f9975 100644 --- a/src/collect-io.c +++ b/src/collect-io.c @@ -163,8 +163,8 @@ static gboolean collection_load_private(CollectionData *cd, const gchar *path, C } /* Read filenames */ - /* TODO: This is not safe! - * Updated: anything within double quotes is considered a filename */ + /** @todo This is not safe! */ + /* Updated: anything within double quotes is considered a filename */ if (!reading_extended_filename) { /* not yet reading filename */ diff --git a/src/collect-table.c b/src/collect-table.c index 71eb1b7b..6bf85df0 100644 --- a/src/collect-table.c +++ b/src/collect-table.c @@ -1522,7 +1522,7 @@ static void collection_table_insert_marker(CollectTable *ct, CollectInfo *info, cairo_t *cr = cairo_create(img); gdk_cairo_set_source_pixbuf(cr, pb, 0, 0); cairo_paint(cr); - // FIXME: this is a hack to get the background color + /** @FIXME this is a hack to get the background color */ //~ pattern = cairo_pattern_create_for_surface(img); pattern = cairo_pattern_create_rgb (1.0, 0.0, 0.0); mask = gdk_cairo_region_create_from_surface(img); @@ -2046,7 +2046,7 @@ static void collection_table_move_by_info_list(CollectTable *ct, GList *info_lis if (info) insert_pos = g_list_find(ct->cd->list, info); - /* FIXME: this may get slow for large lists */ + /** @FIXME this may get slow for large lists */ work = info_list; while (insert_pos && work) { @@ -2502,7 +2502,7 @@ static void collection_table_cell_data_cb(GtkTreeViewColumn *tree_column, GtkCel gtk_tree_model_get(tree_model, iter, CTABLE_COLUMN_POINTER, &list, -1); #if GTK_CHECK_VERSION(3,0,0) - /* FIXME this is a primitive hack to stop a crash. + /** @FIXME this is a primitive hack to stop a crash. * When compiled with GTK3, if a Collection window containing * say, 50 or so, images has its width changed, there is a segfault * https://github.com/BestImageViewer/geeqie/issues/531 diff --git a/src/editors.c b/src/editors.c index 9d853ead..b2ce46d6 100644 --- a/src/editors.c +++ b/src/editors.c @@ -104,7 +104,7 @@ void editor_description_free(EditorDescription *editor) static GList *editor_mime_types_to_extensions(gchar **mime_types) { - /* FIXME: this should be rewritten to use the shared mime database, as soon as we switch to gio */ + /** @FIXME this should be rewritten to use the shared mime database, as soon as we switch to gio */ static const gchar *conv_table[][2] = { {"application/x-ufraw", ".ufraw"}, @@ -1084,7 +1084,7 @@ static EditorFlags editor_command_one(const EditorDescription *editor, GList *li args[n++] = command; args[n] = NULL; - if ((ed->flags & EDITOR_DEST) && fd && fd->change && fd->change->dest) /* FIXME: error handling */ + if ((ed->flags & EDITOR_DEST) && fd && fd->change && fd->change->dest) /** @FIXME error handling */ { g_setenv("GEEQIE_DESTINATION", fd->change->dest, TRUE); } diff --git a/src/exif.c b/src/exif.c index 2c88b668..2062e89b 100644 --- a/src/exif.c +++ b/src/exif.c @@ -1476,8 +1476,7 @@ gint exif_item_get_integer(ExifItem *item, gint *value) *value = (gint)(((gint32 *)(item->data))[0]); return TRUE; break; - case EXIF_FORMAT_LONG_UNSIGNED: - /* FIXME: overflow possible */ + case EXIF_FORMAT_LONG_UNSIGNED: /**< @FIXME overflow possible */ *value = (gint)(((guint32 *)(item->data))[0]); return TRUE; default: diff --git a/src/exiv2.cc b/src/exiv2.cc index 271fa958..7f2cf3ce 100644 --- a/src/exiv2.cc +++ b/src/exiv2.cc @@ -815,7 +815,7 @@ gchar *exif_item_get_string(ExifItem *item, int idx) #if EXIV2_TEST_VERSION(0,16,0) std::string str = em->toString(idx); #else - std::string str = em->toString(); // FIXME + std::string str = em->toString(); /**< @FIXME ?? */ #endif if (idx == 0 && str == "") str = em->toString(); if (str.length() > 5 && str.substr(0, 5) == "lang=") diff --git a/src/filedata.c b/src/filedata.c index a7d4e38c..f2c8795e 100644 --- a/src/filedata.c +++ b/src/filedata.c @@ -2667,7 +2667,7 @@ gint file_data_verify_ci(FileData *fd, GList *list) } else { - if (fd->change->type != FILEDATA_CHANGE_UNSPECIFIED) /* FIXME this is now needed for running editors */ + if (fd->change->type != FILEDATA_CHANGE_UNSPECIFIED) /** @FIXME this is now needed for running editors */ { ret |= CHANGE_WARN_SAME; DEBUG_1("Change checked: source and destination are the same: %s -> %s", fd->path, fd->change->dest); @@ -3003,7 +3003,7 @@ gboolean file_data_apply_ci(FileData *fd) { FileDataChangeType type = fd->change->type; - /* FIXME delete ?*/ + /** @FIXME delete ?*/ if (type == FILEDATA_CHANGE_MOVE || type == FILEDATA_CHANGE_RENAME) { DEBUG_1("planned change: applying %s -> %s", fd->change->dest, fd->path); @@ -3014,7 +3014,8 @@ gboolean file_data_apply_ci(FileData *fd) /* this change overwrites another file which is already known to other modules renaming fd would create duplicate FileData structure the best thing we can do is nothing - FIXME: maybe we could copy stuff like marks + */ + /** @FIXME maybe we could copy stuff like marks */ DEBUG_1("can't rename fd, target exists %s -> %s", fd->change->dest, fd->path); } @@ -3118,8 +3119,8 @@ GList *file_data_process_groups_in_selection(GList *list, gboolean ungroup, GLis * notify other modules about the change described by FileDataChangeInfo */ -/* might use file_maint_ functions for now, later it should be changed to a system of callbacks - FIXME do we need the ignore_list? It looks like a workaround for ineffective +/* might use file_maint_ functions for now, later it should be changed to a system of callbacks */ +/** @FIXME do we need the ignore_list? It looks like a workaround for ineffective implementation in view_file_list.c */ diff --git a/src/filefilter.c b/src/filefilter.c index 88d4d37d..d0679116 100644 --- a/src/filefilter.c +++ b/src/filefilter.c @@ -450,7 +450,7 @@ static const gchar *filter_name_find(GList *filter, const gchar *name) if (ln >= lf) { - /* FIXME: utf8 */ + /** @FIXME utf8 */ if (g_ascii_strncasecmp(name + ln - lf, filter, lf) == 0) return name + ln - lf; } work = work->next; diff --git a/src/format_raw.c b/src/format_raw.c index ca5c23e0..835c2fd3 100644 --- a/src/format_raw.c +++ b/src/format_raw.c @@ -341,8 +341,8 @@ gboolean format_raw_img_exif_offsets_fd(gint fd, const gchar *path, DEBUG_1("RAW file parser extension match"); } - /* FIXME: - * when the target is a tiff file it should be mmaped prior to format_raw_find as + /** + * @FIXME when the target is a tiff file it should be mmaped prior to format_raw_find as * the make field data may not always be within header_data + header_len */ entry = format_raw_find(header_data, header_len); diff --git a/src/fullscreen.c b/src/fullscreen.c index a031b7b8..54b21607 100644 --- a/src/fullscreen.c +++ b/src/fullscreen.c @@ -333,8 +333,8 @@ FullScreenData *fullscreen_start(GtkWidget *window, ImageWindow *imd, /* set timer to block screen saver */ fs->saver_block_id = g_timeout_add(60 * 1000, fullscreen_saver_block_cb, fs); - /* hide normal window - * FIXME: properly restore this window on show + /* hide normal window */ + /** @FIXME properly restore this window on show */ if (fs->same_region) { diff --git a/src/histogram.c b/src/histogram.c index 2dbfde2d..7ef9f764 100644 --- a/src/histogram.c +++ b/src/histogram.c @@ -274,7 +274,7 @@ static void histogram_hgrid(Histogram *histogram, GdkPixbuf *pixbuf, gint x, gin gboolean histogram_draw(Histogram *histogram, const HistMap *histmap, GdkPixbuf *pixbuf, gint x, gint y, gint width, gint height) { - /* FIXME: use the coordinates correctly */ + /** @FIXME use the coordinates correctly */ gint i; gulong max = 0; gdouble logmax; diff --git a/src/image-load.c b/src/image-load.c index 2f0dc8b6..4f722e43 100644 --- a/src/image-load.c +++ b/src/image-load.c @@ -1362,7 +1362,9 @@ const gchar *image_loader_get_error(ImageLoader *il) } -/* FIXME - this can be rather slow and blocks until the size is known */ +/** + * @FIXME this can be rather slow and blocks until the size is known + */ gboolean image_load_dimensions(FileData *fd, gint *width, gint *height) { ImageLoader *il; diff --git a/src/image-overlay.c b/src/image-overlay.c index ff377e8b..90d4c783 100644 --- a/src/image-overlay.c +++ b/src/image-overlay.c @@ -521,7 +521,7 @@ static GdkPixbuf *image_osd_guidelines_render(OverlayStateData *osd) GdkPixbuf *rectangles; ImageWindow *imd = osd->imd; -/* FIXME: guidelines does not work with revised draw signal handling +/** @FIXME guidelines does not work with revised draw signal handling */ //~ pixbuf_renderer_get_scaled_size((PixbufRenderer *)imd->pr, &width, &height); diff --git a/src/image.c b/src/image.c index 177d378a..c81b1c50 100644 --- a/src/image.c +++ b/src/image.c @@ -1406,7 +1406,7 @@ void image_change_pixbuf(ImageWindow *imd, GdkPixbuf *pixbuf, gdouble zoom, gboo lw = layout_find_by_image(imd); if (imd->color_profile_enable && lw && !lw->animation) { - image_post_process_color(imd, 0, FALSE); /* TODO: error handling */ + image_post_process_color(imd, 0, FALSE); /** @todo error handling */ } if (imd->cm || imd->desaturate || imd->overunderexposed) diff --git a/src/image_load_cr3.c b/src/image_load_cr3.c index fefeae5a..73221d48 100644 --- a/src/image_load_cr3.c +++ b/src/image_load_cr3.c @@ -18,7 +18,7 @@ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. */ -/* FIXME: This is just a copy of image_load_jpeg.c, with an adjusted +/** @FIXME This is just a copy of image_load_jpeg.c, with an adjusted * start address for a .cr3 file */ #include "main.h" @@ -262,7 +262,7 @@ static gboolean image_loader_cr3_load (gpointer loader, const guchar *buf, gsize struct error_handler_data jerr; -/* FIXME: Just start search at where full size jpeg should be, +/** @FIXME Just start search at where full size jpeg should be, * / then search through the file looking for a jpeg end-marker */ guint64 align_buf; diff --git a/src/image_load_djvu.c b/src/image_load_djvu.c index 192b2afd..62726819 100644 --- a/src/image_load_djvu.c +++ b/src/image_load_djvu.c @@ -92,7 +92,8 @@ static gboolean image_loader_djvu_load(gpointer loader, const guchar *buf, gsize ddjvu_page_render(page, DDJVU_RENDER_COLOR, &prect, &rrect, fmt, stride, (char *)pixels); - /* FIXME implementation of rotation is not correct */ + /** + * @FIXME implementation of rotation is not correct */ GdkPixbuf *tmp1; GdkPixbuf *tmp2; tmp1 = gdk_pixbuf_new_from_data(pixels, GDK_COLORSPACE_RGB, alpha, 8, width, height, stride, free_buffer, NULL); diff --git a/src/img-view.c b/src/img-view.c index 4e90ee60..eb00f7ce 100644 --- a/src/img-view.c +++ b/src/img-view.c @@ -1444,7 +1444,7 @@ static void view_dir_list_do(ViewWindow *vw, GList *list, gboolean skip, gboolea list = filelist_recursive(fd); } else - { /*FIXME */ + { /** @FIXME ?? */ filelist_read(fd, &list, NULL); list = filelist_sort_path(list); list = filelist_filter(list, FALSE); @@ -1454,7 +1454,7 @@ static void view_dir_list_do(ViewWindow *vw, GList *list, gboolean skip, gboolea } else { - /* FIXME: no filtering here */ + /** @FIXME no filtering here */ vw->list = g_list_append(vw->list, file_data_ref(fd)); } } diff --git a/src/jpeg_parser.c b/src/jpeg_parser.c index 062b2075..7340e73b 100644 --- a/src/jpeg_parser.c +++ b/src/jpeg_parser.c @@ -293,21 +293,21 @@ static gint mpo_parse_Attributes_IFD_entry(const guchar *tiff, guint offset, case 0xb201: mpe->PanOrientation = data_val; break; -/* - -FIXME: -Panorama Scanning Orientation PanOrientation 45569 B201 LONG 1 -Panorama Horizontal Overlap PanOverlap_H 45570 B202 RATIONAL 1 -Panorama Vertical Overlap PanOverlap_V 45571 B203 RATIONAL 1 -Base Viewpoint Number BaseViewpointNum 45572 B204 LONG 1 -Convergence Angle ConvergenceAngle 45573 B205 SRATIONAL 1 -Baseline Length BaselineLength 45574 B206 RATIONAL 1 -Divergence Angle VerticalDivergence 45575 B207 SRATIONAL 1 -Horizontal Axis Distance AxisDistance_X 45576 B208 SRATIONAL 1 -Vertical Axis Distance AxisDistance_Y 45577 B209 SRATIONAL 1 -Collimation Axis Distance AxisDistance_Z 45578 B20A SRATIONAL 1 -Yaw Angle YawAngle 45579 B20B SRATIONAL 1 -Pitch Angle PitchAngle 45580 B20C SRATIONAL 1 +/** + +@FIXME +Panorama Scanning Orientation PanOrientation 45569 B201 LONG 1 \n +Panorama Horizontal Overlap PanOverlap_H 45570 B202 RATIONAL 1 \n +Panorama Vertical Overlap PanOverlap_V 45571 B203 RATIONAL 1 \n +Base Viewpoint Number BaseViewpointNum 45572 B204 LONG 1 \n +Convergence Angle ConvergenceAngle 45573 B205 SRATIONAL 1 \n +Baseline Length BaselineLength 45574 B206 RATIONAL 1 \n +Divergence Angle VerticalDivergence 45575 B207 SRATIONAL 1 \n +Horizontal Axis Distance AxisDistance_X 45576 B208 SRATIONAL 1 \n +Vertical Axis Distance AxisDistance_Y 45577 B209 SRATIONAL 1 \n +Collimation Axis Distance AxisDistance_Z 45578 B20A SRATIONAL 1 \n +Yaw Angle YawAngle 45579 B20B SRATIONAL 1 \n +Pitch Angle PitchAngle 45580 B20C SRATIONAL 1 \n Roll Angle RollAngle 45581 B20D */ default: diff --git a/src/layout.c b/src/layout.c index 165a2593..26b12e62 100644 --- a/src/layout.c +++ b/src/layout.c @@ -206,7 +206,7 @@ static void layout_box_folders_changed_cb(GtkWidget *widget, gpointer data) LayoutWindow *lw; GList *work; -/* FIXME: this is probably not the correct way to implement this */ +/** @FIXME this is probably not the correct way to implement this */ work = layout_window_list; while (work) { @@ -2443,7 +2443,7 @@ void layout_apply_options(LayoutWindow *lw, LayoutOptions *lop) gboolean refresh_lists; if (!layout_valid(&lw)) return; -/* FIXME: add other options too */ +/** @FIXME add other options too */ refresh_style = (lop->style != lw->options.style || strcmp(lop->order, lw->options.order) != 0); refresh_lists = (lop->show_directory_date != lw->options.show_directory_date); @@ -2681,7 +2681,7 @@ LayoutWindow *layout_new_with_geometry(FileData *dir_fd, LayoutOptions *lop, pixbuf = pixbuf_inline(PIXBUF_INLINE_LOGO); - /* FIXME: the zoom value set here is the value, which is then copied again and again + /** @FIXME the zoom value set here is the value, which is then copied again and again in "Leave Zoom at previous setting" mode. This is not ideal. */ image_change_pixbuf(lw->image, pixbuf, 0.0, FALSE); g_object_unref(pixbuf); diff --git a/src/lua.c b/src/lua.c index 916d9c0d..384037fd 100644 --- a/src/lua.c +++ b/src/lua.c @@ -280,7 +280,7 @@ gchar *lua_callvalue(FileData *fd, const gchar *file, const gchar *function) } else { - /* FIXME: what is the correct way to find the scripts folder? */ + /** @FIXME what is the correct way to find the scripts folder? */ ok = access(g_build_filename("/usr/local/lib", GQ_APPNAME_LC, file, NULL), R_OK); if (ok == 0) { diff --git a/src/main.c b/src/main.c index f93f54d5..14c0a7f5 100644 --- a/src/main.c +++ b/src/main.c @@ -62,7 +62,7 @@ #endif #ifdef HAVE_GTHREAD -/* FIXME: see below */ +/** @FIXME see below */ #include #endif @@ -898,7 +898,7 @@ void exit_program(void) * crash otherwise. * Ideas for improvement are welcome ;) */ -/* FIXME: this probably needs some better ifdefs. Please report any compilation problems */ +/** @FIXME this probably needs some better ifdefs. Please report any compilation problems */ #if defined(SIGBUS) && defined(SA_SIGINFO) static void sigbus_handler_cb(int signum, siginfo_t *info, void *context) @@ -1041,7 +1041,7 @@ gint main(gint argc, gchar *argv[]) } #ifdef HAVE_CLUTTER -/* FIXME: For the background of this see: +/** @FIXME For the background of this see: * https://github.com/BestImageViewer/geeqie/issues/397 * The feature CLUTTER_FEATURE_SWAP_EVENTS indictates if the * system is liable to exhibit this problem. diff --git a/src/metadata.c b/src/metadata.c index 4467fb93..a4c7d024 100644 --- a/src/metadata.c +++ b/src/metadata.c @@ -328,7 +328,9 @@ gboolean metadata_write_perform(FileData *fd) (we can't wait until the sidecar is discovered by directory scanning because exif_read_fd is called before that and it would read the main file only and store the metadata in the cache) - FIXME: this does not catch new sidecars created by independent external programs + */ + /** + @FIXME this does not catch new sidecars created by independent external programs */ file_data_unref(file_data_new_group(fd->change->dest)); @@ -1045,7 +1047,7 @@ GList *string_to_keywords_list(const gchar *text) gboolean meta_data_get_keyword_mark(FileData *fd, gint n, gpointer data) { - /* FIXME: do not use global keyword_tree */ + /** @FIXME do not use global keyword_tree */ GList *path = data; GList *keywords; gboolean found = FALSE; diff --git a/src/osd.c b/src/osd.c index 6c39156d..0b88aee5 100644 --- a/src/osd.c +++ b/src/osd.c @@ -371,8 +371,8 @@ gchar *image_osd_mkinfo(const gchar *str, FileData *fd, GHashTable *vars) * "\**\*" -> prefix data with a star, and append a star (ie. "*100*") * "\\*" -> prefix data with an anti slash (ie "\100") * "Collection *\n" -> display data in bold prefixed by "Collection " and a newline is appended - * - * FIXME: using background / foreground colors lead to weird results. + */ + /** @FIXME using background / foreground colors lead to weird results. */ gchar *new_data; gchar *left = NULL; diff --git a/src/pan-view/pan-view-filter.c b/src/pan-view/pan-view-filter.c index fb18fb16..98a6f295 100644 --- a/src/pan-view/pan-view-filter.c +++ b/src/pan-view/pan-view-filter.c @@ -83,8 +83,7 @@ PanViewFilterUi *pan_filter_ui_new(PanWindow *pw) gtk_box_pack_start(GTK_BOX(hbox), combo, TRUE, TRUE, 0); gtk_widget_show(combo); - // TODO(xsdg): Figure out whether it's useful to keep this label around. - ui->filter_label = gtk_label_new(""); + ui->filter_label = gtk_label_new("");/** @todo (xsdg): Figure out whether it's useful to keep this label around. */ //gtk_box_pack_start(GTK_BOX(hbox), ui->filter_label, FALSE, FALSE, 0); //gtk_widget_show(ui->filter_label); @@ -149,7 +148,7 @@ static void pan_filter_kw_button_cb(GtkButton *widget, gpointer data) PanWindow *pw = cb_state->pw; PanViewFilterUi *ui = pw->filter_ui; - // TODO(xsdg): Fix filter element pointed object memory leak. + /** @todo (xsdg): Fix filter element pointed object memory leak. */ ui->filter_elements = g_list_delete_link(ui->filter_elements, cb_state->filter_element); gtk_widget_destroy(GTK_WIDGET(widget)); g_free(cb_state); @@ -188,7 +187,7 @@ void pan_filter_activate_cb(const gchar *text, gpointer data) gtk_tree_model_get(GTK_TREE_MODEL(ui->filter_mode_model), &iter, 2, &short_mode, -1); // Create the button. - // TODO(xsdg): Use MVC so that the button list is an actual representation of the GList + /** @todo (xsdg): Use MVC so that the button list is an actual representation of the GList */ gchar *label = g_strdup_printf("(%s) %s", short_mode, text); kw_button = gtk_button_new_with_label(label); g_clear_pointer(&label, g_free); @@ -338,12 +337,10 @@ gboolean pan_filter_fd_list(GList **fd_list, GList *filter_elements, gint filter } else if (filter_elements) { - // TODO(xsdg): OPTIMIZATION Do the search inside of metadata.c to avoid a - // bunch of string list copies. + /** @todo (xsdg): OPTIMIZATION Do the search inside of metadata.c to avoid a bunch of string list copies. */ GList *img_keywords = metadata_read_list(fd, KEYWORD_KEY, METADATA_PLAIN); - // TODO(xsdg): OPTIMIZATION Determine a heuristic for when to linear-search the - // keywords list, and when to build a hash table for the image's keywords. + /** @todo (xsdg): OPTIMIZATION Determine a heuristic for when to linear-search the keywords list, and when to build a hash table for the image's keywords. */ GList *filter_element = filter_elements; while (filter_element) diff --git a/src/pan-view/pan-view.c b/src/pan-view/pan-view.c index a80c96c8..956ec92f 100644 --- a/src/pan-view/pan-view.c +++ b/src/pan-view/pan-view.c @@ -1883,7 +1883,7 @@ static void pan_window_new_real(FileData *dir_fd) gtk_table_set_row_spacings(GTK_TABLE(table), 2); gtk_table_set_col_spacings(GTK_TABLE(table), 2); - /* FIXME: pan view does not work correctly when renderer-clutter() + /** @FIXME pan view does not work correctly when renderer-clutter() * is used. */ gint temp = options->image.use_clutter_renderer; @@ -2233,7 +2233,7 @@ static void pan_info_toggle_exif_cb(GtkWidget *widget, gpointer data) PanWindow *pw = data; pw->info_includes_exif = gtk_check_menu_item_get_active(GTK_CHECK_MENU_ITEM(widget)); - /* fixme: sync info now */ + /** @FIXME sync info now */ } static void pan_info_toggle_image_cb(GtkWidget *widget, gpointer data) @@ -2241,7 +2241,7 @@ static void pan_info_toggle_image_cb(GtkWidget *widget, gpointer data) PanWindow *pw = data; pw->info_image_size = GPOINTER_TO_INT(g_object_get_data(G_OBJECT(widget), INFO_IMAGE_SIZE_KEY)); - /* fixme: sync info now */ + /** @FIXME sync info now */ } static void pan_fullscreen_cb(GtkWidget *widget, gpointer data) diff --git a/src/pixbuf-renderer.c b/src/pixbuf-renderer.c index 88335165..3653b41e 100644 --- a/src/pixbuf-renderer.c +++ b/src/pixbuf-renderer.c @@ -2986,7 +2986,7 @@ gboolean pixbuf_renderer_get_virtual_rect(PixbufRenderer *pr, GdkRectangle *rect void pixbuf_renderer_set_size_early(PixbufRenderer *pr, guint width, guint height) { #if 0 - /* FIXME: this function does not consider the image orientation, + /** @FIXME this function does not consider the image orientation, so it probably only breaks something */ gdouble zoom; gint w, h; diff --git a/src/remote.c b/src/remote.c index b6c5e403..7149c3c8 100644 --- a/src/remote.c +++ b/src/remote.c @@ -130,7 +130,7 @@ static gboolean remote_server_client_cb(GIOChannel *source, GIOCondition conditi gchar *buffer = NULL; GError *error = NULL; gsize termpos; - /* FIXME: it should be possible to terminate the command with a null character */ + /** @FIXME it should be possible to terminate the command with a null character */ g_io_channel_set_line_term(source, "", -1); while ((status = g_io_channel_read_line(source, &buffer, NULL, &termpos, &error)) == G_IO_STATUS_NORMAL) { diff --git a/src/renderer-clutter.c b/src/renderer-clutter.c index b67e342d..e32c5a47 100644 --- a/src/renderer-clutter.c +++ b/src/renderer-clutter.c @@ -466,7 +466,7 @@ static void rc_update_pixbuf(void *renderer, gboolean lazy) if (width != prev_width || height != prev_height) { - /* FIXME use CoglMaterial with multiple textures for background, color management, anaglyph, ... */ + /** @FIXME use CoglMaterial with multiple textures for background, color management, anaglyph, ... */ CoglHandle texture = cogl_texture_new_with_size(width, height, COGL_TEXTURE_NO_AUTO_MIPMAP, diff --git a/src/renderer-tiles.c b/src/renderer-tiles.c index e828f4bc..a8f0a7d5 100644 --- a/src/renderer-tiles.c +++ b/src/renderer-tiles.c @@ -1460,7 +1460,7 @@ static void rt_tile_render(RendererTiles *rt, ImageTile *it, rt_tile_prepare(rt, it); has_alpha = (pr->pixbuf && gdk_pixbuf_get_has_alpha(pr->pixbuf)); - /* FIXME checker colors for alpha should be configurable, + /** @FIXME checker colors for alpha should be configurable, * also should be drawn for blank = TRUE */ @@ -2087,7 +2087,7 @@ static void rt_scroll(void *renderer, gint x_off, gint y_off) } if (h > 0) { - /* FIXME, to optimize this, remove overlap */ + /** @FIXME to optimize this, remove overlap */ rt_queue(rt, rt->x_scroll, y_off > 0 ? rt->y_scroll + (pr->vis_height - h) : rt->y_scroll, pr->vis_width, h, TRUE, TILE_RENDER_ALL, FALSE, FALSE); diff --git a/src/search.c b/src/search.c index de37de19..1b8da57f 100644 --- a/src/search.c +++ b/src/search.c @@ -1892,7 +1892,7 @@ static gboolean search_file_do_extra(SearchData *sd, FileData *fd, gint *match, tmatch = FALSE; tested = TRUE; - /* fixme: implement similarity checking */ + /** @FIXME implement similarity checking */ if (sd->search_similarity_cd && sd->search_similarity_cd->similarity) { gdouble result; diff --git a/src/secure_save.c b/src/secure_save.c index a6323e48..2fefe7ad 100644 --- a/src/secure_save.c +++ b/src/secure_save.c @@ -68,8 +68,11 @@ * Access rights are affected by secure_open() mask parameter. */ -/* FIXME: locking system on files about to be rewritten ? */ -/* FIXME: Low risk race conditions about ssi->file_name. */ +/** + * @file + * @FIXME locking system on files about to be rewritten ? + * @FIXME Low risk race conditions about ssi->file_name. + */ SecureSaveErrno secsave_errno = SS_ERR_NONE; @@ -270,7 +273,8 @@ secure_close(SecureSaveInfo *ssi) if (ssi->secure_save && ssi->file_name && ssi->tmp_file_name) { struct stat st; - /* FIXME: Race condition on ssi->file_name. The file + /** + * @FIXME Race condition on ssi->file_name. The file * named ssi->file_name may have changed since * secure_open() call (where we stat() file and * more..). */ diff --git a/src/slideshow.c b/src/slideshow.c index 515a24fc..c729eb41 100644 --- a/src/slideshow.c +++ b/src/slideshow.c @@ -378,7 +378,7 @@ static SlideShowData *real_slideshow_start(LayoutWindow *target_lw, ImageWindow ss = g_new0(SlideShowData, 1); ss->lw = target_lw; - ss->imd = imd; /* FIXME: ss->imd is used only for img-view.c and can be dropped with it */ + ss->imd = imd; /** @FIXME ss->imd is used only for img-view.c and can be dropped with it */ ss->filelist = filelist; ss->cd = cd; diff --git a/src/thumb_standard.c b/src/thumb_standard.c index 2998f394..3ac2b4b4 100644 --- a/src/thumb_standard.c +++ b/src/thumb_standard.c @@ -1185,8 +1185,8 @@ static gboolean thumb_std_maint_move_idle(gpointer data) * * The thumbnails are processed when the app is idle. If the app * exits early well too bad - they can simply be regenerated from scratch. - * - * This does not manage local thumbnails (fixme ?) + */ +/** @FIXME This does not manage local thumbnails (fixme ?) */ void thumb_std_maint_moved(const gchar *source, const gchar *dest) { diff --git a/src/toolbar.c b/src/toolbar.c index 4151ab3d..932e7f5c 100644 --- a/src/toolbar.c +++ b/src/toolbar.c @@ -65,7 +65,7 @@ struct _UseableToolbarItems gchar *stock_id; }; -/* FIXME Should be created by program from menu_entries[] +/** @FIXME Should be created by program from menu_entries[] * in layout_util.c */ /** The user is limited to selecting from this list of menu items * plus any desktop files diff --git a/src/typedefs.h b/src/typedefs.h index a4a4033f..ad4c1a3d 100644 --- a/src/typedefs.h +++ b/src/typedefs.h @@ -506,7 +506,7 @@ struct _ImageWindow gboolean unknown; /**< failed to load image */ - ImageLoader *il; /**< FIXME - image loader should probably go to FileData, but it must first support + ImageLoader *il; /**< @FIXME image loader should probably go to FileData, but it must first support sending callbacks to multiple ImageWindows in parallel */ gint has_frame; /**< not boolean, see image_new() */ @@ -917,8 +917,8 @@ struct _ViewDirInfoTree struct _ViewFile { - FileViewType type; - // TODO(xsdg): Turn this into a union (see VFLIST and VFICON from view_file.h). + FileViewType type; /**< @todo (xsdg): Turn this into a union (see VFLIST and VFICON from view_file.h). */ + gpointer info; GtkWidget *widget; @@ -1011,7 +1011,7 @@ struct _SlideShowData { LayoutWindow *lw; /**< use this window to display the slideshow */ ImageWindow *imd; /**< use this window only if lw is not available, - FIXME: it is probably required only by img-view.c and should be dropped with it */ + @FIXME it is probably required only by img-view.c and should be dropped with it */ GList *filelist; CollectionData *cd; diff --git a/src/ui_fileops.c b/src/ui_fileops.c index a721b21a..d14c0ce2 100644 --- a/src/ui_fileops.c +++ b/src/ui_fileops.c @@ -860,7 +860,7 @@ gboolean file_extension_match(const gchar *path, const gchar *ext) p = strlen(path); e = strlen(ext); - /* FIXME: utf8 */ + /** @FIXME utf8 */ return (p > e && g_ascii_strncasecmp(path + p - e, ext, e) == 0); } diff --git a/src/ui_pathsel.c b/src/ui_pathsel.c index a7e255fb..c821330c 100644 --- a/src/ui_pathsel.c +++ b/src/ui_pathsel.c @@ -145,7 +145,8 @@ static gboolean dest_check_filter(const gchar *filter, const gchar *file) } if (*f_ptr != '\0' && f_ptr[1] == ' ') f_ptr++; /* skip space immediately after separator */ f_ptr++; - /* FIXME: utf8 */ + /** + * @FIXME utf8 */ if (l >= i && g_ascii_strncasecmp(file + l - i, strt_ptr, i) == 0) return TRUE; } return FALSE; @@ -737,7 +738,8 @@ static void dest_new_dir_cb(GtkWidget *widget, gpointer data) gchar *path; GtkWidget *dialog_window; -/* FIXME: on exit from the "new folder" modal dialog, focus returns to the main Geeqie +/** + * @FIXME on exit from the "new folder" modal dialog, focus returns to the main Geeqie * window rather than the file dialog window. gtk_window_present() does not seem to * function unless the window was previously minimized. */ diff --git a/src/ui_tabcomp.c b/src/ui_tabcomp.c index 4460ea3b..8b5616d3 100644 --- a/src/ui_tabcomp.c +++ b/src/ui_tabcomp.c @@ -434,7 +434,7 @@ static gboolean tab_completion_do(TabCompData *td) if (entry_text[0] == '\0') { - entry_dir = g_strdup(G_DIR_SEPARATOR_S); /* FIXME: root directory win32 */ + entry_dir = g_strdup(G_DIR_SEPARATOR_S); /** @FIXME root directory win32 */ gtk_entry_set_text(GTK_ENTRY(td->entry), entry_dir); gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(entry_dir)); g_free(entry_dir); @@ -525,7 +525,7 @@ static gboolean tab_completion_do(TabCompData *td) if (strlen(entry_dir) == 0) { g_free(entry_dir); - entry_dir = g_strdup(G_DIR_SEPARATOR_S); /* FIXME: win32 */ + entry_dir = g_strdup(G_DIR_SEPARATOR_S); /** @FIXME win32 */ } if (isdir(entry_dir)) diff --git a/src/utilops.c b/src/utilops.c index fb2f18d7..e65430ca 100644 --- a/src/utilops.c +++ b/src/utilops.c @@ -1527,7 +1527,7 @@ static void file_util_dialog_init_simple_list(UtilityData *ud) const gchar *stock_id; - /* FIXME: use ud->stock_id */ + /** @FIXME use ud->stock_id */ if (ud->type == UTILITY_TYPE_DELETE || ud->type == UTILITY_TYPE_DELETE_LINK || ud->type == UTILITY_TYPE_DELETE_FOLDER) @@ -1886,7 +1886,7 @@ void file_util_dialog_run(UtilityData *ud) ud->phase = UTILITY_PHASE_ENTERING; break; case UTILITY_TYPE_RENAME_FOLDER: - ud->phase = UTILITY_PHASE_CANCEL; /* FIXME - not handled for now */ + ud->phase = UTILITY_PHASE_CANCEL; /**< @FIXME not handled for now */ file_util_dialog_run(ud); return; } diff --git a/src/view_dir.c b/src/view_dir.c index be0fdb0a..425e7ef3 100644 --- a/src/view_dir.c +++ b/src/view_dir.c @@ -51,8 +51,7 @@ static PixmapFolders *folder_icons_new(GtkWidget *widget) pf->open = gtk_widget_render_icon(widget, GTK_STOCK_OPEN, size, NULL); pf->deny = gtk_widget_render_icon(widget, GTK_STOCK_STOP, size, NULL); pf->parent = gtk_widget_render_icon(widget, GTK_STOCK_GO_UP, size, NULL); - /* FIXME: this is not a suitable icon */ - pf->link = gtk_widget_render_icon(widget, GTK_STOCK_REDO, size, NULL); + pf->link = gtk_widget_render_icon(widget, GTK_STOCK_REDO, size, NULL); /** @FIXME this is not a suitable icon */ #else /* GQView legacy icons */ pf->close = pixbuf_inline(PIXBUF_INLINE_FOLDER_CLOSED); @@ -880,7 +879,7 @@ static void vd_dnd_drop_receive(GtkWidget *widget, if (active) { -/* FIXME: With GTK2 gdk_drag_context_get_actions() shows the state of the +/** @FIXME With GTK2 gdk_drag_context_get_actions() shows the state of the * shift and control keys during the drag operation. With GTK3 this is not * so. This is a workaround. */ diff --git a/src/view_dir_tree.c b/src/view_dir_tree.c index 009639c1..e4134501 100644 --- a/src/view_dir_tree.c +++ b/src/view_dir_tree.c @@ -782,6 +782,7 @@ void vdtree_refresh(ViewDir *vd) const gchar *vdtree_row_get_path(ViewDir *vd, gint row) { +/** @FIXME no get row path */ log_printf("FIXME: no get row path\n"); return NULL; } diff --git a/src/view_file/view_file.c b/src/view_file/view_file.c index 5e6674ac..58172584 100644 --- a/src/view_file/view_file.c +++ b/src/view_file/view_file.c @@ -1625,7 +1625,7 @@ void vf_notify_cb(FileData *fd, NotifyType type, gpointer data) NotifyType interested = NOTIFY_CHANGE | NOTIFY_REREAD | NOTIFY_GROUPING; if (vf->marks_enabled) interested |= NOTIFY_MARKS | NOTIFY_METADATA; - /* FIXME: NOTIFY_METADATA should be checked by the keyword-to-mark functions and converted to NOTIFY_MARKS only if there was a change */ + /** @FIXME NOTIFY_METADATA should be checked by the keyword-to-mark functions and converted to NOTIFY_MARKS only if there was a change */ if (!(type & interested) || vf->refresh_idle_id || !vf->dir_fd) return; diff --git a/src/view_file/view_file_icon.c b/src/view_file/view_file_icon.c index 177e272a..779c0e0a 100644 --- a/src/view_file/view_file_icon.c +++ b/src/view_file/view_file_icon.c @@ -1135,7 +1135,7 @@ static void vficon_set_focus(ViewFile *vf, FileData *fd) /* ensure focus row col are correct */ vficon_find_position(vf, VFICON(vf)->focus_fd, &VFICON(vf)->focus_row, &VFICON(vf)->focus_column); #if GTK_CHECK_VERSION(3,0,0) -/* FIXME: Refer to issue #467 on Github. The thumbnail position is not +/** @FIXME Refer to issue #467 on Github. The thumbnail position is not * preserved when the icon view is refreshed. Caused by an unknown call from * the idle loop. This patch hides the problem. */ @@ -1799,7 +1799,7 @@ FileData *vficon_thumb_next_fd(ViewFile *vf) GList *list; gtk_tree_model_get(store, &iter, FILE_COLUMN_POINTER, &list, -1); - // TODO(xsdg): for loop here. + /** @todo (xsdg): for loop here. */ for (; list; list = list->next) { FileData *fd = list->data; diff --git a/src/view_file/view_file_list.c b/src/view_file/view_file_list.c index 6418b410..8ae57c8a 100644 --- a/src/view_file/view_file_list.c +++ b/src/view_file/view_file_list.c @@ -742,7 +742,7 @@ static void vflist_select_image(ViewFile *vf, FileData *sel_fd) if (sel_fd == cur_fd) return; /* no change */ row = g_list_index(vf->list, sel_fd); - // FIXME sidecar data + /** @FIXME sidecar data */ if (sel_fd && options->image.enable_read_ahead && row >= 0) { @@ -1400,7 +1400,7 @@ gint vflist_index_by_fd(ViewFile *vf, FileData *fd) work2 = list_fd->sidecar_files; while (work2) { - /* FIXME: return the same index also for sidecars + /** @FIXME return the same index also for sidecars it is sufficient for next/prev navigation but it should be rewritten without using indexes at all */ @@ -1948,8 +1948,8 @@ gboolean vflist_refresh(ViewFile *vf) } else { - // FIXME: only do this when needed (aka when we just switched from - // FIXME: marks-enabled to marks-disabled) + /** @FIXME only do this when needed (aka when we just switched from */ + /** @FIXME marks-enabled to marks-disabled) */ file_data_unlock_list(vf->list); }