X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=bgzf.h;h=9984d8fe8ea9146330335ac1d4ff5ed9db454ad5;hb=65d1a7c9ce767f6d6eb9166a1158e1468722097f;hp=2a70bb902771d937432602045842bf7e0cf1711c;hpb=bbf6f360e153cf98d091afdaa31717448cde21e9;p=samtools.git

diff --git a/bgzf.h b/bgzf.h
index 2a70bb9..9984d8f 100644
--- a/bgzf.h
+++ b/bgzf.h
@@ -190,6 +190,13 @@ extern "C" {
 	 */
 	int bgzf_read_block(BGZF *fp);
 
+	/**
+	 * Enable multi-threading (only effective on writing)
+	 *
+	 * @param fp          BGZF file handler; must be opened for writing
+	 * @param n_threads   #threads used for writing
+	 * @param n_sub_blks  #blocks processed by each thread; a value 64-256 is recommended
+	 */
 	int bgzf_mt(BGZF *fp, int n_threads, int n_sub_blks);
 
 #ifdef __cplusplus