[Gearbox-commit] SF.net SVN: gearbox: [171] gearbox/trunk/src/gbxgarminacfr/nmea.h

[<rus...@us...>]

Revision: 171
          http://gearbox.svn.sourceforge.net/gearbox/?rev=171&view=rev
Author:   russo2503v
Date:     2008-06-09 00:56:03 -0700 (Mon, 09 Jun 2008)

Log Message:
-----------
cosmetic

Modified Paths:
--------------
    gearbox/trunk/src/gbxgarminacfr/nmea.h

Modified: gearbox/trunk/src/gbxgarminacfr/nmea.h
===================================================================
--- gearbox/trunk/src/gbxgarminacfr/nmea.h	2008-06-09 06:34:23 UTC (rev 170)
+++ gearbox/trunk/src/gbxgarminacfr/nmea.h	2008-06-09 07:56:03 UTC (rev 171)
@@ -80,27 +80,28 @@
     NmeaMessage();
     NmeaMessage(const char *sentence, int testCheckSum=DontTestOrAddChecksum );
 
-    // Set up the internal data for a sentence
+    // Set up the internal data for a sentence.
+    // May throw NmeaException if TestChecksum is specified.
     void setSentence(const char *data, int testCheckSum=DontTestOrAddChecksum );
 
-    // Do we only have the raw string ?
+    // Do we only have the raw string?
     bool haveSentence() const { return haveSentence_; };
 
-    // Have we parsed fields ?
+    // Do we have parsed fields?
     bool haveTokens() const { return haveTokens_; };
 
-    // have we a valid checksum ?
+    // Do we have a valid checksum?
     bool haveValidChecksum() const { return checkSumOK_; };  
   
-    // have we checked the checksum?
+    // Have we checked the checksum?
     bool haveTestedChecksum()const { return haveCheckSum_; };  
   
     // calculate the checksum from sentence
-    // Note that this function may throw NMEA_Exception...
+    // May throw NmeaException.
     bool testChecksumOk();
 
     // Return the raw sentence string
-    const char * sentence() { return sentence_; };
+    const char* sentence() { return sentence_; };
 
     // Return a single data token as a string
     std::string& getDataToken(int i) { return dataTokens_[i]; };
@@ -113,6 +114,7 @@
 
 private:
     void init();
+    // May throw NmeaException.
     void addCheckSum();
     // Do we only have the raw string ?
     bool haveSentence_;


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.