Changeset 3029 for trunk/yat/omic/BamRead.h

Timestamp:

Apr 21, 2013, 3:04:41 AM (10 years ago)

Author:

Peter

Message:

refs #746. Add docs and throw in aux_del if tag is absent (rather than undefined behaviour)

File:

• trunk/yat/omic/BamRead.h (modified) (3 diffs)

trunk/yat/omic/BamRead.h

@@ -114 +114 @@
     /**
        \return pointer to auxiliary data
+
+       \see aux_size(void)
      */
     const uint8_t* aux(void) const;
 
     /**
+       Use bam_aux2? functions (in samtools C api) to convert returned
+       pointer to corresponding type.
+
+       \return pointer to field associated with \a tag, NULL if \a tag
+       doesn't exist.
+
+       \see bam_aux_get
+
        \since New in yat 0.11
      */
@@ -123 +133 @@
 
     /**
-       \since New in yat 0.11
-     */
-    void aux(const char tag[2], char type, int len, uint8_t* data);
-
-    /**
-       \since New in yat 0.11
+       \brief append a new tag to aux field
+
+       \param tag two-charcter tag to append
+       \param type describes which type and can be 'iIsScCdfAZH'
+       \param len length of data
+       \param data pointer to data
+
+       \since New in yat 0.11
+
+       \see SAM specification
      */
     void aux_append(const char tag[2], char type, int len, uint8_t* data);
 
     /**
+       \brief remove a tag in aux field
+
+       \throw utility::runtime_error if \a tag is not present in read
+
        \since New in yat 0.11
      */
@@ -138 +156 @@
 
     /**
+       \return length of aux field
+
        \since New in yat 0.11
      */