Skip to content

Commit

Permalink
Document that bam_aux_del()'s s parameter must be non-NULL (& refor…
Browse files Browse the repository at this point in the history
…mat)
  • Loading branch information
jmarshall authored and jkbonfield committed Aug 30, 2022
1 parent a92615b commit 2ff03d3
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions htslib/sam.h
Original file line number Diff line number Diff line change
Expand Up @@ -1777,11 +1777,13 @@ HTSLIB_EXPORT
int bam_aux_append(bam1_t *b, const char tag[2], char type, int len, const uint8_t *data);

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

0 comments on commit 2ff03d3

Please sign in to comment.