diff options
Diffstat (limited to 'src/regex/regex_block_lib.h')
| -rw-r--r-- | src/regex/regex_block_lib.h | 55 |
1 files changed, 27 insertions, 28 deletions
diff --git a/src/regex/regex_block_lib.h b/src/regex/regex_block_lib.h index e5685ba9a2..20cfd6cebe 100644 --- a/src/regex/regex_block_lib.h +++ b/src/regex/regex_block_lib.h @@ -52,7 +52,8 @@ struct RegexBlock; struct REGEX_BLOCK_Edge { /** - * Label of the edge. FIXME: might want to not consume exactly multiples of 8 bits, need length! + * Label of the edge. FIXME: might want to not consume exactly + * multiples of 8 bits, need length! */ const char *label; @@ -67,10 +68,9 @@ struct REGEX_BLOCK_Edge * Check if the given 'proof' matches the given 'key'. * * @param proof partial regex of a state - * @param proof_len number of bytes in 'proof' + * @param proof_len number of bytes in @a proof * @param key hash of a state. - * - * @return GNUNET_OK if the proof is valid for the given key. + * @return #GNUNET_OK if the proof is valid for the given key. */ int REGEX_BLOCK_check_proof (const char *proof, @@ -82,14 +82,13 @@ REGEX_BLOCK_check_proof (const char *proof, * 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 query the query for the block + * @param size The size of the @a block. + * @param query the query for the @a 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. + * @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, @@ -107,13 +106,13 @@ REGEX_BLOCK_check (const struct RegexBlock *block, * @param token Token that follows to next state. * @param len Length of token. * @param key Hash of next state. - * - * @return GNUNET_YES if should keep iterating, GNUNET_NO otherwise. + * @return #GNUNET_YES if should keep iterating, #GNUNET_NO otherwise. */ -typedef int (*REGEX_INTERNAL_EgdeIterator)(void *cls, - const char *token, - size_t len, - const struct GNUNET_HashCode *key); +typedef int +(*REGEX_INTERNAL_EgdeIterator)(void *cls, + const char *token, + size_t len, + const struct GNUNET_HashCode *key); /** @@ -122,29 +121,29 @@ typedef int (*REGEX_INTERNAL_EgdeIterator)(void *cls, * @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. + * @param iter_cls Closure for the @a 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 + * #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, - REGEX_INTERNAL_EgdeIterator iterator, - void *iter_cls); + size_t size, + REGEX_INTERNAL_EgdeIterator iterator, + void *iter_cls); + /** * Obtain the key that a particular block is to be stored under. * * @param block block to get the key from - * @param block_len number of bytes in block + * @param block_len number of bytes in @a block * @param key where to store the key - * @return GNUNET_OK on success, GNUNET_SYSERR if the block is malformed + * @return #GNUNET_OK on success, #GNUNET_SYSERR if the block is malformed */ int REGEX_BLOCK_get_key (const struct RegexBlock *block, @@ -157,7 +156,7 @@ REGEX_BLOCK_get_key (const struct RegexBlock *block, * * @param block block to test * @param size number of bytes in block - * @return GNUNET_YES if the block is accepting, GNUNET_NO if not + * @return #GNUNET_YES if the block is accepting, #GNUNET_NO if not */ int GNUNET_BLOCK_is_accepting (const struct RegexBlock *block, |