Updated Doxygen comments

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

diff --git a/src/api/SamProgram.h b/src/api/SamProgram.h
index 3c89059bdaedeeaf0b287b9c4fd3a2aae794002e..54da8723ca04dd0c263a14c47130aad412dd61c7 100644 (file)
--- a/src/api/SamProgram.h
+++ b/src/api/SamProgram.h
@@ -1,9 +1,8 @@
 // ***************************************************************************
 // SamProgram.h (c) 2011 Derek Barnett
 // Marth Lab, Department of Biology, Boston College
-// All rights reserved.
 // ---------------------------------------------------------------------------
-// Last modified: 19 April 2011 (DB)
+// Last modified: 10 October 2011 (DB)
 // ---------------------------------------------------------------------------
 // Provides direct read/write access to the SAM header program records.
 // ***************************************************************************
@@ -27,21 +26,21 @@ struct API_EXPORT SamProgram {
     ~SamProgram(void);
 
     // query/modify entire program record
-    void Clear(void);                           // clears all data fields
+    void Clear(void);                      // clears all data fields
 
     // convenience query methods
-    bool HasCommandLine(void) const;            // returns true if program record has a command line entry
-    bool HasID(void) const;                     // returns true if program record has an ID
-    bool HasName(void) const;                   // returns true if program record has a name
-    bool HasPreviousProgramID(void) const;      // returns true if program record has a 'previous program ID'
-    bool HasVersion(void) const;                // returns true if program record has a version
+    bool HasCommandLine(void) const;       // returns true if program record has a command line entry
+    bool HasID(void) const;                // returns true if program record has an ID
+    bool HasName(void) const;              // returns true if program record has a name
+    bool HasPreviousProgramID(void) const; // returns true if program record has a 'previous program ID'
+    bool HasVersion(void) const;           // returns true if program record has a version
 
     // data members
-    std::string CommandLine;                    // CL:<CommandLine>
-    std::string ID;                             // ID:<ID>          *Required for valid SAM header*
-    std::string Name;                           // PN:<Name>
-    std::string PreviousProgramID;              // PP:<PreviousProgramID>
-    std::string Version;                        // VN:<Version>
+    std::string CommandLine;               // CL:<CommandLine>
+    std::string ID;                        // ID:<ID>          *Required for valid SAM header*
+    std::string Name;                      // PN:<Name>
+    std::string PreviousProgramID;         // PP:<PreviousProgramID>
+    std::string Version;                   // VN:<Version>
 
     // internal (non-standard) methods & fields
     private: