From 1a2fa0923cc82c80111f13cbde3ab3f99e47c1d5 Mon Sep 17 00:00:00 2001 From: Celine Mercier Date: Thu, 21 Apr 2016 11:35:21 +0200 Subject: [PATCH] Documented the functions indexing and retrieving character strings --- src/char_str_indexer.h | 30 ++++++++++++++++++++++++++++-- 1 file changed, 28 insertions(+), 2 deletions(-) diff --git a/src/char_str_indexer.h b/src/char_str_indexer.h index 08a3179..48d30ce 100644 --- a/src/char_str_indexer.h +++ b/src/char_str_indexer.h @@ -41,9 +41,11 @@ Obi_blob_p obi_str_to_blob(char* value); /** * @brief Converts a blob to a character string. * + * @warning The character string returned is mapped. + * * @param value_b The blob to convert. * - * @returns A pointer to the character string contained in the blob. + * @returns A pointer on the character string contained in the blob. * * @since October 2015 * @author Celine Mercier (celine.mercier@metabarcoding.org) @@ -51,9 +53,33 @@ Obi_blob_p obi_str_to_blob(char* value); const char* obi_blob_to_str(Obi_blob_p value_b); -// TODO doc +/** + * @brief Stores a character string in an indexer and returns the index. + * + * @param indexer The indexer structure. + * @param value The character string to index. + * + * @returns The index referring to the stored character string in the indexer. + * + * @since April 2016 + * @author Celine Mercier (celine.mercier@metabarcoding.org) + */ index_t obi_index_char_str(Obi_indexer_p indexer, const char* value); + +/** + * @brief Retrieves a character string from an indexer. + * + * @warning The character string returned is mapped. + * + * @param indexer The indexer structure. + * @param idx The index referring to the character string to retrieve in the indexer. + * + * @returns A pointer on the character string. + * + * @since April 2016 + * @author Celine Mercier (celine.mercier@metabarcoding.org) + */ char* obi_retrieve_char_str(Obi_indexer_p indexer, index_t idx);