Commit 1941a378 by Celine Mercier

Updated encode functions documentation

parent c7b8db6a
...@@ -22,10 +22,10 @@ ...@@ -22,10 +22,10 @@
#include "obitypes.h" #include "obitypes.h"
#define NUC_MASK_2B 0x3 /**< Binary: 11 to use when decoding 2 bits sequences #define NUC_MASK_2B 0x3 /**< Binary: 11 to use when decoding 2 bits sequences
*/ */
#define NUC_MASK_4B 0xF /**< Binary: 1111 to use when decoding 4 bits sequences #define NUC_MASK_4B 0xF /**< Binary: 1111 to use when decoding 4 bits sequences
*/ */
/** /**
...@@ -107,7 +107,7 @@ byte_t* encode_seq_on_2_bits(const char* seq, int32_t length); ...@@ -107,7 +107,7 @@ byte_t* encode_seq_on_2_bits(const char* seq, int32_t length);
* 10 -> t * 10 -> t
* 11 -> g * 11 -> g
* *
* @param seq The sequence to decode. * @param seq_b The sequence to decode.
* @param length_seq The initial length of the sequence before it was encoded. * @param length_seq The initial length of the sequence before it was encoded.
* *
* @returns The decoded sequence ended with '\0'. * @returns The decoded sequence ended with '\0'.
...@@ -169,7 +169,7 @@ byte_t* encode_seq_on_4_bits(const char* seq, int32_t length); ...@@ -169,7 +169,7 @@ byte_t* encode_seq_on_4_bits(const char* seq, int32_t length);
* V or v : 1110 * V or v : 1110
* N or n : 1111 * N or n : 1111
* *
* @param seq The sequence to decode. * @param seq_b The sequence to decode.
* @param length_seq The initial length of the sequence before it was encoded. * @param length_seq The initial length of the sequence before it was encoded.
* *
* @returns The decoded sequence ended with '\0'. * @returns The decoded sequence ended with '\0'.
......
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