-playing with doxygen groups

1 files changed, 62 insertions, 3 deletions

diff --git a/src/include/gnunet_common.h b/src/include/gnunet_common.h
index ab0876ef9..4552e860e 100644
--- a/src/include/gnunet_common.h
+++ b/src/include/gnunet_common.h
@@ -1,10 +1,10 @@
 /*
      This file is part of GNUnet.
-     (C) 2006, 2009 Christian Grothoff (and other contributing authors)
+     (C) 2006-2013 Christian Grothoff (and other contributing authors)
 
      GNUnet is free software; you can redistribute it and/or modify
      it under the terms of the GNU General Public License as published
-     by the Free Software Foundation; either version 2, or (at your
+     by the Free Software Foundation; either version 3, or (at your
      option) any later version.
 
      GNUnet is distributed in the hope that it will be useful, but
@@ -26,6 +26,9 @@
  *
  * @author Christian Grothoff
  * @author Nils Durner
+ *
+ * @defgroup logging Logging
+ * @defgroup memory Memory management
  */
 #ifndef GNUNET_COMMON_H
 #define GNUNET_COMMON_H
@@ -104,6 +107,7 @@ extern "C"
 #endif
 
 /**
+ * @ingroup logging
  * define GNUNET_EXTRA_LOGGING if using this header outside the GNUnet source
  * tree where gnunet_config.h is unavailable
  */
@@ -288,6 +292,7 @@ typedef int (*GNUNET_FileNameCallback) (void *cls, const char *filename);
 /* ****************************** logging ***************************** */
 
 /**
+ * @ingroup logging
  * Types of errors.
  */
 enum GNUNET_ErrorType
@@ -304,6 +309,7 @@ enum GNUNET_ErrorType
 
 
 /**
+ * @ingroup logging
  * User-defined handler for log messages.
  *
  * @param cls closure
@@ -318,6 +324,7 @@ typedef void (*GNUNET_Logger) (void *cls, enum GNUNET_ErrorType kind,
 
 
 /**
+ * @ingroup logging
  * Get the number of log calls that are going to be skipped
  *
  * @return number of log calls to be ignored
@@ -333,6 +340,7 @@ GNUNET_get_log_call_status (int caller_level, const char *comp,
 
 
 /**
+ * @ingroup logging
  * Main log function.
  *
  * @param kind how serious is the error?
@@ -364,7 +372,9 @@ GNUNET_log_nocheck (enum GNUNET_ErrorType kind, const char *message, ...);
 #define GNUNET_LOG_CALL_STATUS -1
 #endif
 
+
 /**
+ * @ingroup logging
  * Log function that specifies an alternative component.
  * This function should be used by plugins.
  *
@@ -410,6 +420,7 @@ GNUNET_log_from_nocheck (enum GNUNET_ErrorType kind, const char *comp,
 
 
 /**
+ * @ingroup logging
  * Log error message about missing configuration option.
  *
  * @param kind log level
@@ -423,6 +434,7 @@ GNUNET_log_config_missing (enum GNUNET_ErrorType kind,
 
 
 /**
+ * @ingroup logging
  * Log error message about invalid configuration option value.
  *
  * @param kind log level
@@ -438,13 +450,16 @@ GNUNET_log_config_invalid (enum GNUNET_ErrorType kind,
 
 
 /**
+ * @ingroup logging
  * Abort the process, generate a core dump if possible.
  */
 void
 GNUNET_abort (void) GNUNET_NORETURN;
 
+
 /**
- * Ignore the next n calls to the log function.
+ * @ingroup logging
+ * Ignore the next @a n calls to the log function.
  *
  * @param n number of log calls to ignore (could be negative)
  * @param check_reset GNUNET_YES to assert that the log skip counter is currently zero
@@ -454,6 +469,7 @@ GNUNET_log_skip (int n, int check_reset);
 
 
 /**
+ * @ingroup logging
  * Setup logging.
  *
  * @param comp default component to use
@@ -466,6 +482,7 @@ GNUNET_log_setup (const char *comp, const char *loglevel, const char *logfile);
 
 
 /**
+ * @ingroup logging
  * Add a custom logger.
  *
  * @param logger log function
@@ -476,6 +493,7 @@ GNUNET_logger_add (GNUNET_Logger logger, void *logger_cls);
 
 
 /**
+ * @ingroup logging
  * Remove a custom logger.
  *
  * @param logger log function
@@ -486,6 +504,7 @@ GNUNET_logger_remove (GNUNET_Logger logger, void *logger_cls);
 
 
 /**
+ * @ingroup logging
  * Convert a short hash value to a string (for printing debug messages).
  * This is one of the very few calls in the entire API that is
  * NOT reentrant!
@@ -498,6 +517,7 @@ GNUNET_short_h2s (const struct GNUNET_CRYPTO_ShortHashCode * hc);
 
 
 /**
+ * @ingroup logging
  * Convert a short hash value to a string (for printing debug messages).
  * This prints all 104 characters of a hashcode!
  * This is one of the very few calls in the entire API that is
@@ -511,6 +531,7 @@ GNUNET_short_h2s_full (const struct GNUNET_CRYPTO_ShortHashCode * hc);
 
 
 /**
+ * @ingroup logging
  * Convert a hash value to a string (for printing debug messages).
  * This is one of the very few calls in the entire API that is
  * NOT reentrant!
@@ -523,6 +544,7 @@ GNUNET_h2s (const struct GNUNET_HashCode * hc);
 
 
 /**
+ * @ingroup logging
  * Convert a hash value to a string (for printing debug messages).
  * This prints all 104 characters of a hashcode!
  * This is one of the very few calls in the entire API that is
@@ -536,6 +558,7 @@ GNUNET_h2s_full (const struct GNUNET_HashCode * hc);
 
 
 /**
+ * @ingroup logging
  * Convert a peer identity to a string (for printing debug messages).
  * This is one of the very few calls in the entire API that is
  * NOT reentrant!
@@ -547,7 +570,9 @@ GNUNET_h2s_full (const struct GNUNET_HashCode * hc);
 const char *
 GNUNET_i2s (const struct GNUNET_PeerIdentity *pid);
 
+
 /**
+ * @ingroup logging
  * Convert a peer identity to a string (for printing debug messages).
  * This is one of the very few calls in the entire API that is
  * NOT reentrant!
@@ -559,7 +584,9 @@ GNUNET_i2s (const struct GNUNET_PeerIdentity *pid);
 const char *
 GNUNET_i2s_full (const struct GNUNET_PeerIdentity *pid);
 
+
 /**
+ * @ingroup logging
  * Convert a "struct sockaddr*" (IPv4 or IPv6 address) to a string
  * (for printing debug messages).  This is one of the very few calls
  * in the entire API that is NOT reentrant!
@@ -572,7 +599,9 @@ GNUNET_i2s_full (const struct GNUNET_PeerIdentity *pid);
 const char *
 GNUNET_a2s (const struct sockaddr *addr, socklen_t addrlen);
 
+
 /**
+ * @ingroup logging
  * Convert error type to string.
  *
  * @param kind type to convert
@@ -583,22 +612,29 @@ GNUNET_error_type_to_string (enum GNUNET_ErrorType kind);
 
 
 /**
+ * @ingroup logging
  * Use this for fatal errors that cannot be handled
  */
 #define GNUNET_assert(cond) do { if (! (cond)) { GNUNET_log(GNUNET_ERROR_TYPE_ERROR, _("Assertion failed at %s:%d.\n"), __FILE__, __LINE__); GNUNET_abort(); } } while(0)
 
+
 /**
+ * @ingroup logging
  * Use this for fatal errors that cannot be handled
  */
 #define GNUNET_assert_at(cond, f, l) do { if (! (cond)) { GNUNET_log(GNUNET_ERROR_TYPE_ERROR, _("Assertion failed at %s:%d.\n"), f, l); GNUNET_abort(); } } while(0)
 
+
 /**
+ * @ingroup logging
  * Use this for internal assertion violations that are
  * not fatal (can be handled) but should not occur.
  */
 #define GNUNET_break(cond)  do { if (! (cond)) { GNUNET_log(GNUNET_ERROR_TYPE_ERROR, _("Assertion failed at %s:%d.\n"), __FILE__, __LINE__); } } while(0)
 
+
 /**
+ * @ingroup logging
  * Use this for assertion violations caused by other
  * peers (i.e. protocol violations).  We do not want to
  * confuse end-users (say, some other peer runs an
@@ -608,28 +644,36 @@ GNUNET_error_type_to_string (enum GNUNET_ErrorType kind);
  */
 #define GNUNET_break_op(cond)  do { if (! (cond)) { GNUNET_log(GNUNET_ERROR_TYPE_WARNING | GNUNET_ERROR_TYPE_BULK, _("External protocol violation detected at %s:%d.\n"), __FILE__, __LINE__); } } while(0)
 
+
 /**
+ * @ingroup logging
  * Log an error message at log-level 'level' that indicates
  * a failure of the command 'cmd' with the message given
  * by strerror(errno).
  */
 #define GNUNET_log_strerror(level, cmd) do { GNUNET_log(level, _("`%s' failed at %s:%d with error: %s\n"), cmd, __FILE__, __LINE__, STRERROR(errno)); } while(0)
 
+
 /**
+ * @ingroup logging
  * Log an error message at log-level 'level' that indicates
  * a failure of the command 'cmd' with the message given
  * by strerror(errno).
  */
 #define GNUNET_log_from_strerror(level, component, cmd) do { GNUNET_log_from (level, component, _("`%s' failed at %s:%d with error: %s\n"), cmd, __FILE__, __LINE__, STRERROR(errno)); } while(0)
 
+
 /**
+ * @ingroup logging
  * Log an error message at log-level 'level' that indicates
  * a failure of the command 'cmd' with the message given
  * by strerror(errno).
  */
 #define GNUNET_log_strerror_file(level, cmd, filename) do { GNUNET_log(level, _("`%s' failed on file `%s' at %s:%d with error: %s\n"), cmd, filename,__FILE__, __LINE__, STRERROR(errno)); } while(0)
 
+
 /**
+ * @ingroup logging
  * Log an error message at log-level 'level' that indicates
  * a failure of the command 'cmd' with the message given
  * by strerror(errno).
@@ -673,11 +717,13 @@ GNUNET_ntoh_double (double d);
 /* ************************* allocation functions ****************** */
 
 /**
+ * @ingroup memory
  * Maximum allocation with GNUNET_malloc macro.
  */
 #define GNUNET_MAX_MALLOC_CHECKED (1024 * 1024 * 40)
 
 /**
+ * @ingroup memory
  * Allocate a struct or union of the given 'type'.
  * Wrapper around GNUNET_malloc that returns a pointer
  * to the newly created object of the correct type.
@@ -687,6 +733,7 @@ GNUNET_ntoh_double (double d);
 #define GNUNET_new(type) (type *) GNUNET_malloc (sizeof (type))
 
 /**
+ * @ingroup memory
  * Wrapper around malloc. Allocates size bytes of memory.
  * The memory will be zero'ed out.
  *
@@ -697,6 +744,7 @@ GNUNET_ntoh_double (double d);
 #define GNUNET_malloc(size) GNUNET_xmalloc_(size, __FILE__, __LINE__)
 
 /**
+ * @ingroup memory
  * Allocate and initialize a block of memory.
  *
  * @param buf data to initalize the block with
@@ -706,6 +754,7 @@ GNUNET_ntoh_double (double d);
 #define GNUNET_memdup(buf,size) GNUNET_xmemdup_(buf, size, __FILE__, __LINE__)
 
 /**
+ * @ingroup memory
  * Wrapper around malloc. Allocates size bytes of memory.
  * The memory will be zero'ed out.
  *
@@ -715,6 +764,7 @@ GNUNET_ntoh_double (double d);
 #define GNUNET_malloc_large(size) GNUNET_xmalloc_unchecked_(size, __FILE__, __LINE__)
 
 /**
+ * @ingroup memory
  * Wrapper around realloc. Rellocates size bytes of memory.
  *
  * @param ptr the pointer to reallocate
@@ -724,6 +774,7 @@ GNUNET_ntoh_double (double d);
 #define GNUNET_realloc(ptr, size) GNUNET_xrealloc_(ptr, size, __FILE__, __LINE__)
 
 /**
+ * @ingroup memory
  * Wrapper around free. Frees the memory referred to by ptr.
  * Note that is is generally better to free memory that was
  * allocated with GNUNET_array_grow using GNUNET_array_grow(mem, size, 0) instead of GNUNET_free.
@@ -734,6 +785,7 @@ GNUNET_ntoh_double (double d);
 #define GNUNET_free(ptr) GNUNET_xfree_(ptr, __FILE__, __LINE__)
 
 /**
+ * @ingroup memory
  * Free the memory pointed to by ptr if ptr is not NULL.
  * Equivalent to if (ptr!=null)GNUNET_free(ptr).
  *
@@ -742,6 +794,7 @@ GNUNET_ntoh_double (double d);
 #define GNUNET_free_non_null(ptr) do { void * __x__ = ptr; if (__x__ != NULL) { GNUNET_free(__x__); } } while(0)
 
 /**
+ * @ingroup memory
  * Wrapper around GNUNET_strdup.  Makes a copy of the zero-terminated string
  * pointed to by a.
  *
@@ -751,6 +804,7 @@ GNUNET_ntoh_double (double d);
 #define GNUNET_strdup(a) GNUNET_xstrdup_(a,__FILE__,__LINE__)
 
 /**
+ * @ingroup memory
  * Wrapper around GNUNET_strndup.  Makes a partial copy of the string
  * pointed to by a.
  *
@@ -761,6 +815,7 @@ GNUNET_ntoh_double (double d);
 #define GNUNET_strndup(a,length) GNUNET_xstrndup_(a,length,__FILE__,__LINE__)
 
 /**
+ * @ingroup memory
  * Grow a well-typed (!) array.  This is a convenience
  * method to grow a vector <tt>arr</tt> of size <tt>size</tt>
  * to the new (target) size <tt>tsize</tt>.
@@ -796,12 +851,14 @@ GNUNET_ntoh_double (double d);
 #define GNUNET_array_grow(arr,size,tsize) GNUNET_xgrow_((void**)&arr, sizeof(arr[0]), &size, tsize, __FILE__, __LINE__)
 
 /**
+ * @ingroup memory
  * Append an element to a list (growing the
  * list by one).
  */
 #define GNUNET_array_append(arr,size,element) do { GNUNET_array_grow(arr,size,size+1); arr[size-1] = element; } while(0)
 
 /**
+ * @ingroup memory
  * Like snprintf, just aborts if the buffer is of insufficient size.
  *
  * @param buf pointer to buffer that is written to
@@ -815,6 +872,7 @@ GNUNET_snprintf (char *buf, size_t size, const char *format, ...);
 
 
 /**
+ * @ingroup memory
  * Like asprintf, just portable.
  *
  * @param buf set to a buffer of sufficient size (allocated, caller must free)
@@ -938,6 +996,7 @@ GNUNET_xgrow_ (void **old, size_t elementSize, unsigned int *oldCount,
 
 
 /**
+ * @ingroup memory
  * Create a copy of the given message.
  *
  * @param msg message to copy