Skip to content

Commit 78ee824

Browse files
committed
Document that bam_aux_del()'s s parameter must be non-NULL (& reformat)
1 parent 10d63e1 commit 78ee824

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

htslib/sam.h

+7-5
Original file line numberDiff line numberDiff line change
@@ -1777,11 +1777,13 @@ HTSLIB_EXPORT
17771777
int bam_aux_append(bam1_t *b, const char tag[2], char type, int len, const uint8_t *data);
17781778

17791779
/// Delete tag data from a bam record
1780-
/* @param b The bam record to update
1781-
@param s Pointer to the tag to delete, as returned by bam_aux_get().
1782-
@return 0 on success; -1 on failure
1783-
If the bam record's aux data is corrupt, errno is set to EINVAL and this
1784-
function returns -1;
1780+
/** @param b The BAM record to update
1781+
@param s Pointer to the aux field to delete, as returned by bam_aux_get()
1782+
Must not be NULL
1783+
@return 0 on success; -1 on failure
1784+
1785+
If the BAM record's aux data is corrupt, errno is set to EINVAL and this
1786+
function returns -1.
17851787
*/
17861788
HTSLIB_EXPORT
17871789
int bam_aux_del(bam1_t *b, uint8_t *s);

0 commit comments

Comments
 (0)