Commit 1a2fa092 authored by Celine Mercier's avatar Celine Mercier

Documented the functions indexing and retrieving character strings

parent 00f2f2cc
......@@ -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);
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment