commented out wrong message type

[oweals/gnunet.git] / src / statistics / statistics.h

diff --git a/src/statistics/statistics.h b/src/statistics/statistics.h
index 3aa59da9ddd119167b4eb2025302fe618fca8297..41863a64f7c16e7b634d7b7b91e9b4e311a6b23c 100644 (file)
--- a/src/statistics/statistics.h
+++ b/src/statistics/statistics.h
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet.
-     (C) 2001, 2002, 2003, 2004, 2009 Christian Grothoff (and other contributing authors)
+     Copyright (C) 2001-2014 GNUnet e.V.
 
      GNUnet is free software; you can redistribute it and/or modify
      it under the terms of the GNU General Public License as published
@@ -14,8 +14,8 @@
 
      You should have received a copy of the GNU General Public License
      along with GNUnet; see the file COPYING.  If not, write to the
-     Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-     Boston, MA 02111-1307, USA.
+     Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+     Boston, MA 02110-1301, USA.
 */
 
 /**
@@ -47,7 +47,8 @@ struct GNUNET_STATISTICS_ReplyMessage
   /**
    * Unique numerical identifier for the value (will
    * not change during the same client-session).  Highest
-   * bit will be set for persistent values.
+   * bit will be set for persistent values (see
+   * #GNUNET_STATISTICS_PERSIST_BIT).
    */
   uint32_t uid GNUNET_PACKED;
 
@@ -58,14 +59,31 @@ struct GNUNET_STATISTICS_ReplyMessage
 
 };
 
-#define GNUNET_STATISTICS_PERSIST_BIT (1<<31)
+/**
+ * Flag for the `struct GNUNET_STATISTICS_ReplyMessage` UID only.
+ * Note that other messages use #GNUNET_STATISTICS_SETFLAG_PERSISTENT.
+ */
+#define GNUNET_STATISTICS_PERSIST_BIT ((uint32_t) (1LLU<<31))
 
+/**
+ * The value being set is an absolute change.
+ */
 #define GNUNET_STATISTICS_SETFLAG_ABSOLUTE 0
 
+/**
+ * The value being set is a relative change.
+ */
 #define GNUNET_STATISTICS_SETFLAG_RELATIVE 1
 
+/**
+ * The value being set is to be persistent (note that
+ * this bit can be combined with #GNUNET_STATISTICS_SETFLAG_RELATIVE).
+ * This value must not be used for the `uid` member of
+ * `struct GNUNET_STATISTICS_ReplyMessage`!
+ */
 #define GNUNET_STATISTICS_SETFLAG_PERSISTENT 2
 
+
 /**
  * Message to set a statistic.  Followed
  * by the subsystem name and the name of
@@ -74,7 +92,7 @@ struct GNUNET_STATISTICS_ReplyMessage
 struct GNUNET_STATISTICS_SetMessage
 {
   /**
-   * Type: GNUNET_MESSAGE_TYPE_STATISTICS_SET
+   * Type: #GNUNET_MESSAGE_TYPE_STATISTICS_SET
    */
   struct GNUNET_MessageHeader header;
 
@@ -99,7 +117,7 @@ struct GNUNET_STATISTICS_SetMessage
 struct GNUNET_STATISTICS_WatchValueMessage
 {
   /**
-   * Type: GNUNET_MESSAGE_TYPE_STATISTICS_WATCH_VALUE
+   * Type: #GNUNET_MESSAGE_TYPE_STATISTICS_WATCH_VALUE
    */
   struct GNUNET_MessageHeader header;