Updated Doxygen comments

[bamtools.git] / src / api / SamReadGroup.h

diff --git a/src/api/SamReadGroup.h b/src/api/SamReadGroup.h
index b1fbfb8ac04d72bb6c4cb9ebd4f3a5ea0d99a565..093ce2d76eea1d0624e6fa075508bd56e03be8ed 100644 (file)
--- a/src/api/SamReadGroup.h
+++ b/src/api/SamReadGroup.h
@@ -2,7 +2,7 @@
 // SamReadGroup.h (c) 2010 Derek Barnett
 // Marth Lab, Department of Biology, Boston College
 // ---------------------------------------------------------------------------
-// Last modified: 18 April 2011 (DB)
+// Last modified: 10 October 2011 (DB)
 // ---------------------------------------------------------------------------
 // Provides direct read/write access to the SAM read group data fields.
 // ***************************************************************************
@@ -24,36 +24,36 @@ struct API_EXPORT SamReadGroup {
     ~SamReadGroup(void);
 
     // query/modify entire read group
-    void Clear(void);                           // clears all data fields
+    void Clear(void);                          // clears all data fields
 
     // convenience query methods
-    bool HasDescription(void) const;            // returns true if read group has a description
-    bool HasFlowOrder(void) const;              // returns true if read group has a flow order entry
-    bool HasID(void) const;                     // returns true if read group has a group ID
-    bool HasKeySequence(void) const;            // returns true if read group has a key sequence
-    bool HasLibrary(void) const;                // returns true if read group has a library name
-    bool HasPlatformUnit(void) const;           // returns true if read group has a platform unit ID
-    bool HasPredictedInsertSize(void) const;    // returns true if read group has a predicted insert size
-    bool HasProductionDate(void) const;         // returns true if read group has a production date
-    bool HasProgram(void) const;                // returns true if read group has a program entry
-    bool HasSample(void) const;                 // returns true if read group has a sample name
-    bool HasSequencingCenter(void) const;       // returns true if read group has a sequencing center ID
-    bool HasSequencingTechnology(void) const;   // returns true if read group has a sequencing technology ID
+    bool HasDescription(void) const;           // returns true if read group has a description
+    bool HasFlowOrder(void) const;             // returns true if read group has a flow order entry
+    bool HasID(void) const;                    // returns true if read group has a group ID
+    bool HasKeySequence(void) const;           // returns true if read group has a key sequence
+    bool HasLibrary(void) const;               // returns true if read group has a library name
+    bool HasPlatformUnit(void) const;          // returns true if read group has a platform unit ID
+    bool HasPredictedInsertSize(void) const;   // returns true if read group has a predicted insert size
+    bool HasProductionDate(void) const;        // returns true if read group has a production date
+    bool HasProgram(void) const;               // returns true if read group has a program entry
+    bool HasSample(void) const;                // returns true if read group has a sample name
+    bool HasSequencingCenter(void) const;      // returns true if read group has a sequencing center ID
+    bool HasSequencingTechnology(void) const;  // returns true if read group has a sequencing technology ID
 
 
     // data fields
-    std::string Description;                    // DS:<Description>
-    std::string FlowOrder;                      // FO:<FlowOrder>
-    std::string ID;                             // ID:<ID>              *Required for valid SAM header*
-    std::string KeySequence;                    // KS:<KeySequence>
-    std::string Library;                        // LB:<Library>
-    std::string PlatformUnit;                   // PU:<PlatformUnit>
-    std::string PredictedInsertSize;            // PI:<PredictedInsertSize>
-    std::string ProductionDate;                 // DT:<ProductionDate>
-    std::string Program;                        // PG:<Program>
-    std::string Sample;                         // SM:<Sample>
-    std::string SequencingCenter;               // CN:<SequencingCenter>
-    std::string SequencingTechnology;           // PL:<SequencingTechnology>
+    std::string Description;                   // DS:<Description>
+    std::string FlowOrder;                     // FO:<FlowOrder>
+    std::string ID;                            // ID:<ID>              *Required for valid SAM header*
+    std::string KeySequence;                   // KS:<KeySequence>
+    std::string Library;                       // LB:<Library>
+    std::string PlatformUnit;                  // PU:<PlatformUnit>
+    std::string PredictedInsertSize;           // PI:<PredictedInsertSize>
+    std::string ProductionDate;                // DT:<ProductionDate>
+    std::string Program;                       // PG:<Program>
+    std::string Sample;                        // SM:<Sample>
+    std::string SequencingCenter;              // CN:<SequencingCenter>
+    std::string SequencingTechnology;          // PL:<SequencingTechnology>
 };
 
 /*! \fn bool operator==(const SamReadGroup& lhs, const SamReadGroup& rhs)