From 915c6c192559858743368e84c522ed57167f84ba Mon Sep 17 00:00:00 2001 From: Zilong-Li Date: Thu, 26 Sep 2024 09:52:51 +0200 Subject: [PATCH] update doc and test --- test/Makefile | 1 - vcfpp.h | 12 ++++++------ 2 files changed, 6 insertions(+), 7 deletions(-) diff --git a/test/Makefile b/test/Makefile index 91bcfd3..a1e0108 100644 --- a/test/Makefile +++ b/test/Makefile @@ -30,4 +30,3 @@ test: ./bcf-reader.bin --success ./bcf-writer.bin --success ./bcf-variant.bin --success - ./example.bin --success diff --git a/vcfpp.h b/vcfpp.h index 8d12822..46394d9 100644 --- a/vcfpp.h +++ b/vcfpp.h @@ -1648,10 +1648,10 @@ class BcfReader /** * @brief query the status of a given region in the VCF * @return -2: the region is not a valid bcftools-like format, - or it is not presenting in the VCF even though it's bcftols-like format. - -1: there is no index file found. - 0: the region is valid but empty. - 1: vaild and not empty. + * or it is not presenting in the VCF even though it's bcftols-like format. \n + * -1: there is no index file found. \n + * 0: the region is valid but empty. \n + * 1: vaild and not empty. \n */ int getStatus(const std::string & region) { @@ -1674,8 +1674,8 @@ class BcfReader /** * @brief count the number of variants by iterating through a given region. - * @note If you want to continue work on that region, remember to reset the region by setRegion! - Also, check the status of the region first to handle the different cases + * @note If you want to continue work on that region, remember to reset the region by setRegion()! \n + * Also, check the status of the region first to handle the different cases! */ int getVariantsCount(const std::string & region) {