Convert general file comments in .c files to Doxygen style comments
authorColin Clark <colin.clark@cclark.uk>
Sat, 24 Apr 2021 08:56:20 +0000 (09:56 +0100)
committerColin Clark <colin.clark@cclark.uk>
Sat, 24 Apr 2021 08:56:20 +0000 (09:56 +0100)
src/cache.c
src/history_list.c
src/secure_save.c
src/similar.c
src/thumb_standard.c
src/ui_tabcomp.c

index 9dbc84b..fee9db9 100644 (file)
 #include <errno.h>
 
 
-/*
+/**
+ * @file
  *-------------------------------------------------------------------
  * Cache data file format:
  *-------------------------------------------------------------------
  *
- * SIMcache
- * #comment
- * Dimensions=[<width> x <height>]
- * Date=[<value in time_t format, or -1 if no embedded date>]
- * MD5sum=[<32 character ascii text digest>]
+ * SIMcache \n
+ * #comment \n
+ * Dimensions=[<width> x <height>] \n
+ * Date=[<value in time_t format, or -1 if no embedded date>] \n
+ * MD5sum=[<32 character ascii text digest>] \n
  * SimilarityGrid[32 x 32]=<3072 bytes of data (1024 pixels in RGB format, 1 pixel is 24bits)>
  *
- *
- * The first line (9 bytes) indicates it is a SIMcache format file. (new line char must exist)
- * Comment lines starting with a # are ignored up to a new line.
- * All data lines should end with a new line char.
- * Format is very strict, data must begin with the char immediately following '='.
- * Currently SimilarityGrid is always assumed to be 32 x 32 RGB.
+ * The first line (9 bytes) indicates it is a SIMcache format file. (new line char must exist) \n
+ * Comment lines starting with a # are ignored up to a new line. \n
+ * All data lines should end with a new line char. \n
+ * Format is very strict, data must begin with the char immediately following '='. \n
+ * Currently SimilarityGrid is always assumed to be 32 x 32 RGB. \n
  */
 
 
index 4131626..9077903 100644 (file)
 #include "ui_fileops.h"
 
 
-/*
+/**
+ * @file
  *-----------------------------------------------------------------------------
  * Implements a history chain. Used by the Back and Forward toolbar buttons.
  * Selecting any folder appends the path to the end of the chain.
  * Pressing the Back and Forward buttons moves along the chain, but does
  * not make additions to the chain.
  * The chain always increases and is deleted at the end of the session
+ * 
  *-----------------------------------------------------------------------------
  */
 
@@ -98,13 +100,15 @@ void history_chain_append_end(const gchar *path)
                }
 }
 
-/*
+/**
+ * @file
  *-----------------------------------------------------------------------------
  * Implements an image history chain. Whenever an image is displayed it is
  * appended to a chain.
  * Pressing the Image Back and Image Forward buttons moves along the chain,
  * but does not make additions to the chain.
  * The chain always increases and is deleted at the end of the session
+ * 
  *-----------------------------------------------------------------------------
  */
 static GList *image_chain = NULL;
index f2f4f53..a6323e4 100644 (file)
 
 #include "secure_save.h"
 
-
-/* ABOUT SECURE SAVE */
-/* This code was borrowed from the ELinks project (http://elinks.cz)
+/**
+ * @file secure_save.c
+ * 
+ * ABOUT SECURE SAVE \n
+ * This code was borrowed from the ELinks project (http://elinks.cz)
  * It was originally written by me (Laurent Monin aka Zas) and heavily
  * modified and improved by all ELinks contributors.
  * This code was released under the GPLv2 licence.
- * It was modified to be included in geeqie on 2008/04/05 */
-
-/* If ssi->secure_save is TRUE:
- * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ * It was modified to be included in geeqie on 2008/04/05
+ * If ssi->secure_save is TRUE:
  *
  * A call to secure_open("/home/me/.confdir/filename", mask) will open a file
  * named "filename.tmp_XXXXXX" in /home/me/.confdir/ and return a pointer to a
  * then secsave is disabled for that file.
  *
  * If ssi->secure_save is FALSE:
- * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  *
  * No temporary file is created, "filename" is truncated, all operations are
  * done on it, no rename nor flush occur, symlinks are preserved.
  *
  * In both cases:
- * ~~~~~~~~~~~~~
  *
  * Access rights are affected by secure_open() mask parameter.
  */
index 56aae23..ef18859 100644 (file)
@@ -23,7 +23,9 @@
 #include "main.h"
 #include "similar.h"
 
-/*
+/**
+ * @file
+ * 
  * These functions are intended to find images with similar color content. For
  * example when an image was saved at different compression levels or dimensions
  * (scaled down/up) the contents are similar, but these files do not match by file
@@ -40,9 +42,9 @@
  * of the two images. (for this, simple comparisons are used, basically the return
  * is an average of the corresponding array differences)
  *
- * for image_sim_compare(), the return is 0.0 to 1.0:
- *  1.0 for exact matches (an image is compared to itself)
- *  0.0 for exact opposite images (compare an all black to an all white image)
+ * for image_sim_compare(), the return is 0.0 to 1.0: \n
+ *  1.0 for exact matches (an image is compared to itself) \n
+ *  0.0 for exact opposite images (compare an all black to an all white image) \n
  * generally only a match of > 0.85 are significant at all, and >.95 is useful to
  * find images that have been re-saved to other formats, dimensions, or compression.
  */
index 657760f..43ab9fe 100644 (file)
 #include "metadata.h"
 
 
-/*
+/**
+ * @file
+ * 
  * This thumbnail caching implementation attempts to conform
  * to the Thumbnail Managing Standard proposed on freedesktop.org
- * The standard is documented here:
- *   http://triq.net/~jens/thumbnail-spec/index.html
+ * The standard is documented here: \n
+ *   http://triq.net/~jens/thumbnail-spec/index.html \n
  *  (why isn't it actually hosted on freedesktop.org?)
  *
  * This code attempts to conform to version 0.7.0 of the standard.
  *
  * Notes:
  *   > Validation of the thumb's embedded uri is a simple strcmp between our
- *     version of the escaped uri and the thumb's escaped uri. But not all uri
- *     escape functions escape the same set of chars, comparing the unescaped
- *     versions may be more accurate.
+ *   > version of the escaped uri and the thumb's escaped uri. But not all uri
+ *   > escape functions escape the same set of chars, comparing the unescaped
+ *   > versions may be more accurate. \n
  *   > Only Thumb::URI and Thumb::MTime are stored in a thumb at this time.
  *     Storing the Size, Width, Height should probably be implemented.
  */
index 511071c..4460ea3 100644 (file)
 #endif
 
 
-/* ----------------------------------------------------------------
-   Tab completion routines, can be connected to any gtkentry widget
-   using the tab_completion_add_to_entry() function.
-   Use remove_trailing_slash() to strip the trailing G_DIR_SEPARATOR.
-   ----------------------------------------------------------------*/
+/**
+ * @file
+ * ----------------------------------------------------------------
+ * Tab completion routines, can be connected to any gtkentry widget
+ * using the tab_completion_add_to_entry() function.
+ * 
+ * Use remove_trailing_slash() to strip the trailing G_DIR_SEPARATOR.
+ * 
+ * ----------------------------------------------------------------
+ */
 
 typedef struct _TabCompData TabCompData;
 struct _TabCompData