Commit 2c680073 authored by Luis Pedro Coelho's avatar Luis Pedro Coelho
Browse files

Improve documentation

parent 2e7c741e
......@@ -69,7 +69,11 @@ std::map<std::string,filePosition> mapGenes;
split_interval_map<long,GeneDef> geneIntervals;
/**
* @brief Fast string tokanizer. (thread safe too)
* @brief Fast thread-safe string tokenizer.
*
* It ignores any spaces at the beginning of the string.
*
* Returns position after the token separator
*/
const char *toksplit(const char *src, /* Source of tokens */
char tokchar, /* token delimiting char */
......@@ -295,7 +299,7 @@ bool isPersonalSNP(std::map<char,long*>& map, int nrSamples, std::string snp) {
}
/**
* @brief Guess what this function does!
* @brief Return a reverse complemented copy of the input
*/
std::string revComplement(std::string codon) {
......@@ -332,7 +336,7 @@ std::string getCoverageString(std::map<char,long*>& map, int nrSamples, std::str
}
/**
* @brief This is where shit happens!
* @brief Main function
*/
int main(int argc, char** argv) {
......
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