Added sentence examples in javadocs.

ktuukkan · Jun 7, 2014 · 5d1b7fc · 5d1b7fc
1 parent 193c8c7
commit 5d1b7fc
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 5 deletions.
diff --git a/src/main/java/net/sf/marineapi/nmea/sentence/APBSentence.java b/src/main/java/net/sf/marineapi/nmea/sentence/APBSentence.java
@@ -35,6 +35,9 @@
  * destination".
  * </p>
  * 
+ * <p>Example:<br/>
+ * <code>$GPAPB,A,A,0.10,R,N,V,V,011,M,DEST,011,M,011,M*82</code></p>
+ * 
  * @author Kimmo Tuukkanen
  */
 public interface APBSentence extends Sentence {

diff --git a/src/main/java/net/sf/marineapi/nmea/sentence/DTMSentence.java b/src/main/java/net/sf/marineapi/nmea/sentence/DTMSentence.java
@@ -21,7 +21,10 @@
 package net.sf.marineapi.nmea.sentence;
 
 /**
- * Datum reference.
+ * <p>Datum reference.</p>
+ * 
+ * <p>Example:<br/>
+ * <code>$GPDTM,W84,,0.000000,N,0.000000,E,0.0,W84*6F</code></p>
  * 
  * @author Kimmo Tuukkanen
  */

diff --git a/src/main/java/net/sf/marineapi/nmea/sentence/VLWSentence.java b/src/main/java/net/sf/marineapi/nmea/sentence/VLWSentence.java
@@ -22,7 +22,10 @@
 
 
 /**
- * Distance traveled through water, cumulative and trip.
+ * <p>Distance traveled through water, cumulative and trip.</p>
+ * 
+ * <p>Example:<br/>
+ * <code>$VWVLW,2.8,N,2.8,N*4C</code></p>
  * 
  * @author Kimmo Tuukkanen
  */

diff --git a/src/main/resources/doc/readme.txt b/src/main/resources/doc/readme.txt
@@ -83,7 +83,16 @@ documents publicly available in the Internet (URLs checked on 2013-09-08):
 
  * RT Intertial+ NMEA Description (rev. 100720) by Oxford Technical Solutions
    <http://www.oxts.com/Downloads/Products/Inertial2/nmeaman.pdf>
+
+ * Trimble BD9xx GNSS Receivers Help
+   <http://www.trimble.com/OEM_ReceiverHelp/V4.44/en/>
 
+ * Eye4Software GPS Toolkit - Description of supported NMEA0183 sentences
+   <http://www.eye4software.com/products/gpstoolkit/nmea/>
+
+ * NMEA 0183 Sentences Not Recommended for New Designs by NMEA
+   <http://www.nmea.org/Assets/100108_nmea_0183_sentences_not_recommended_for_new_designs.pdf>
+
  * NMEA Sentence Information by Glenn Baddeley
    <http://home.mira.net/~gnb/gps/nmea.html>
 
@@ -94,9 +103,6 @@ documents publicly available in the Internet (URLs checked on 2013-09-08):
    <http://vancouver-webpages.com/peter/nmeafaq.txt> (not found)
    <http://www.eoss.org/pubs/nmeafaq.htm> (archived older version)
 
- * NMEA 0183 Sentences Not Recommended for New Designs by NMEA
-   <http://www.nmea.org/Assets/100108_nmea_0183_sentences_not_recommended_for_new_designs.pdf>
-
  * NMEA Sentence Information by Glenn Baddeley
    <http://home.mira.net/~gnb/gps/nmea.html>