-misc doxygen fixes

1 files changed, 21 insertions, 14 deletions

diff --git a/src/include/gnunet_statistics_service.h b/src/include/gnunet_statistics_service.h
index 5e41edc5b..c2fb46109 100644
--- a/src/include/gnunet_statistics_service.h
+++ b/src/include/gnunet_statistics_service.h
@@ -1,10 +1,10 @@
 /*
       This file is part of GNUnet
-      (C) 2009, 2010 Christian Grothoff (and other contributing authors)
+      (C) 2009-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
@@ -24,6 +24,8 @@
  *        the operation of GNUnet; all statistical values
  *        must be of type "unsigned long long".
  * @author Christian Grothoff
+ * @defgroup statistics track statistics or provide access to statistics
+ * @{
  */
 
 #ifndef GNUNET_STATISTICS_SERVICE_H
@@ -58,8 +60,8 @@ struct GNUNET_STATISTICS_Handle;
  * @param subsystem name of subsystem that created the statistic
  * @param name the name of the datum
  * @param value the current value
- * @param is_persistent GNUNET_YES if the value is persistent, GNUNET_NO if not
- * @return GNUNET_OK to continue, GNUNET_SYSERR to abort iteration
+ * @param is_persistent #GNUNET_YES if the value is persistent, #GNUNET_NO if not
+ * @return #GNUNET_OK to continue, #GNUNET_SYSERR to abort iteration
  */
 typedef int (*GNUNET_STATISTICS_Iterator) (void *cls, const char *subsystem,
                                            const char *name, uint64_t value,
@@ -82,7 +84,7 @@ GNUNET_STATISTICS_create (const char *subsystem,
  * it).
  *
  * @param h statistics handle to destroy
- * @param sync_first set to GNUNET_YES if pending SET requests should
+ * @param sync_first set to #GNUNET_YES if pending SET requests should
  *        be completed
  */
 void
@@ -96,8 +98,8 @@ GNUNET_STATISTICS_destroy (struct GNUNET_STATISTICS_Handle *h, int sync_first);
  * @param subsystem limit to the specified subsystem, never NULL
  * @param name name of the statistic value, never NULL
  * @param proc function to call on each value
- * @param proc_cls closure for proc
- * @return GNUNET_OK on success, GNUNET_SYSERR on error
+ * @param proc_cls closure for @a proc
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
  */
 int
 GNUNET_STATISTICS_watch (struct GNUNET_STATISTICS_Handle *handle,
@@ -112,8 +114,8 @@ GNUNET_STATISTICS_watch (struct GNUNET_STATISTICS_Handle *handle,
  * @param subsystem limit to the specified subsystem, never NULL
  * @param name name of the statistic value, never NULL
  * @param proc function to call on each value
- * @param proc_cls closure for proc
- * @return GNUNET_OK on success, GNUNET_SYSERR on error (no such watch)
+ * @param proc_cls closure for @a proc
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR on error (no such watch)
  */
 int
 GNUNET_STATISTICS_watch_cancel (struct GNUNET_STATISTICS_Handle *handle,
@@ -122,11 +124,12 @@ GNUNET_STATISTICS_watch_cancel (struct GNUNET_STATISTICS_Handle *handle,
 
 
 /**
- * Continuation called by the "get_all" and "get" functions.
+ * Continuation called by the #GNUNET_STATISTICS_get_all
+ * and #GNUNET_STATISTICS_get functions.
  *
  * @param cls closure
- * @param success GNUNET_OK if statistics were
- *        successfully obtained, GNUNET_SYSERR if not.
+ * @param success #GNUNET_OK if statistics were
+ *        successfully obtained, #GNUNET_SYSERR if not.
  */
 typedef void (*GNUNET_STATISTICS_Callback) (void *cls, int success);
 
@@ -136,6 +139,7 @@ typedef void (*GNUNET_STATISTICS_Callback) (void *cls, int success);
  */
 struct GNUNET_STATISTICS_GetHandle;
 
+
 /**
  * Get statistic from the peer.
  *
@@ -147,7 +151,7 @@ struct GNUNET_STATISTICS_GetHandle;
  * @param cont continuation to call when done (can be NULL)
  *        This callback CANNOT destroy the statistics handle in the same call.
  * @param proc function to call on each value
- * @param cls closure for proc and cont
+ * @param cls closure for @a proc and @a cont
  * @return NULL on error
  */
 struct GNUNET_STATISTICS_GetHandle *
@@ -159,7 +163,7 @@ GNUNET_STATISTICS_get (struct GNUNET_STATISTICS_Handle *handle,
 
 
 /**
- * Cancel a 'get' request.  Must be called before the 'cont'
+ * Cancel a #GNUNET_STATISICS_get request.  Must be called before the 'cont'
  * function is called.
  *
  * @param gh handle of the request to cancel
@@ -181,6 +185,7 @@ void
 GNUNET_STATISTICS_set (struct GNUNET_STATISTICS_Handle *handle,
                        const char *name, uint64_t value, int make_persistent);
 
+
 /**
  * Set statistic value for the peer.  Will always use our
  * subsystem (the argument used when "handle" was created).
@@ -203,4 +208,6 @@ GNUNET_STATISTICS_update (struct GNUNET_STATISTICS_Handle *handle,
 }
 #endif
 
+/** @} */ /* end of group statistics */
+
 #endif