[GNUnet-SVN] r33124 - gnunet/src/core

[gnunet]

Author: grothoff
Date: 2014-04-23 11:27:40 +0200 (Wed, 23 Apr 2014)
New Revision: 33124

Modified:
   gnunet/src/core/gnunet-service-core_typemap.h
Log:
-comments

Modified: gnunet/src/core/gnunet-service-core_typemap.h
===================================================================
--- gnunet/src/core/gnunet-service-core_typemap.h       2014-04-23 09:25:02 UTC 
(rev 33123)
+++ gnunet/src/core/gnunet-service-core_typemap.h       2014-04-23 09:27:40 UTC 
(rev 33124)
@@ -37,16 +37,24 @@
 
 /**
  * Add a set of types to our type map.
+ *
+ * @param types array of message types supported by this peer
+ * @param tlen number of entries in @a types
  */
 void
-GSC_TYPEMAP_add (const uint16_t * types, unsigned int tlen);
+GSC_TYPEMAP_add (const uint16_t *types,
+                 unsigned int tlen);
 
 
 /**
- * Remove a set of types from our type map.
+ * Remove a set of message types from our type map.
+ *
+ * @param types array of message types no longer supported by this peer
+ * @param tlen number of entries in @a types
  */
 void
-GSC_TYPEMAP_remove (const uint16_t * types, unsigned int tlen);
+GSC_TYPEMAP_remove (const uint16_t *types,
+                    unsigned int tlen);
 
 
 /**
@@ -59,7 +67,9 @@
 
 
 /**
- * Extract a type map from a TYPE_MAP message.
+ * Extract a type map from a
+ * #GNUNET_MESSAGE_TYPE_CORE_COMRESSED_TYPE_MAP or
+ * #GNUNET_MESSAGE_TYPE_CORE_BINARY_TYPE_MAP message.
  *
  * @param msg a type map message
  * @return NULL on error
@@ -74,11 +84,12 @@
  *
  * @param tmap map to test
  * @param types array of types
- * @param tcnt number of entries in types
- * @return GNUNET_YES if a type is in the map, GNUNET_NO if not
+ * @param tcnt number of entries in @a types
+ * @return #GNUNET_YES if a type is in the map, #GNUNET_NO if not
  */
 int
-GSC_TYPEMAP_test_match (const struct GSC_TypeMap *tmap, const uint16_t * types,
+GSC_TYPEMAP_test_match (const struct GSC_TypeMap *tmap,
+                        const uint16_t *types,
                         unsigned int tcnt);
 
 
@@ -87,13 +98,15 @@
  *
  * @param tmap map to extend (not changed)
  * @param types array of types to add
- * @param tcnt number of entries in types
+ * @param tcnt number of entries in @a types
  * @return updated type map (fresh copy)
  */
 struct GSC_TypeMap *
-GSC_TYPEMAP_extend (const struct GSC_TypeMap *tmap, const uint16_t * types,
+GSC_TYPEMAP_extend (const struct GSC_TypeMap *tmap,
+                    const uint16_t *types,
                     unsigned int tcnt);
 
+
 /**
  * Create an empty type map.
  *