[GNUnet-SVN] r27623 - gnunet/src/regex

[gnunet]

Author: grothoff
Date: 2013-06-26 13:53:06 +0200 (Wed, 26 Jun 2013)
New Revision: 27623

Modified:
   gnunet/src/regex/regex_block_lib.c
Log:
-duping comments from declarations to definitions

Modified: gnunet/src/regex/regex_block_lib.c
===================================================================
--- gnunet/src/regex/regex_block_lib.c  2013-06-26 11:51:44 UTC (rev 27622)
+++ gnunet/src/regex/regex_block_lib.c  2013-06-26 11:53:06 UTC (rev 27623)
@@ -81,10 +81,22 @@
 }
 
 
+/**
+ * Check if the regex block is well formed, including all edges.
+ *
+ * @param block The start of the block.
+ * @param size The size of the block.
+ * @param xquery String describing the edge we are looking for.
+ *               Can be NULL in case this is a put block.
+ *
+ * @return GNUNET_OK in case it's fine.
+ *         GNUNET_NO in case the xquery exists and is not found (IRRELEVANT).
+ *         GNUNET_SYSERR if the block is invalid.
+ */
 int
 REGEX_BLOCK_check (const struct RegexBlock *block,
-                           size_t size,
-                           const char *xquery)
+                  size_t size,
+                  const char *xquery)
 {
   int res;
   struct regex_block_xquery_ctx ctx;
@@ -108,6 +120,22 @@
 }
 
 
+/**
+ * Iterate over all edges of a block of a regex state.
+ *
+ * @param block Block to iterate over.
+ * @param size Size of block.
+ * @param iterator Function to call on each edge in the block.
+ * @param iter_cls Closure for the iterator.
+ *
+ * @return GNUNET_SYSERR if an error has been encountered.
+ *         GNUNET_OK if no error has been encountered.
+ *           Note that if the iterator stops the iteration by returning
+ *         GNUNET_NO, the block will no longer be checked for further errors.
+ *           The return value will be GNUNET_OK meaning that no errors were
+ *         found until the edge last notified to the iterator, but there might
+ *         be errors in further edges.
+ */
 int
 REGEX_BLOCK_iterate (const struct RegexBlock *block,
                             size_t size,