aboutsummaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorHerbert von Broeuschmeul <Herbert.Broeuschmeul@gmail.com>2011-01-30 22:47:39 +0100
committerHerbert von Broeuschmeul <Herbert.Broeuschmeul@gmail.com>2011-01-30 22:47:39 +0100
commit751719019ae20c11205fa8ac4ea35fbf79f890e3 (patch)
tree8571a348139cd2f51ca6966a9e2590fe44357f05 /src
parentafeee82cf52c30a9c6f507ed5783b59d3b7173da (diff)
downloadBlueGPS-751719019ae20c11205fa8ac4ea35fbf79f890e3.zip
BlueGPS-751719019ae20c11205fa8ac4ea35fbf79f890e3.tar.gz
BlueGPS-751719019ae20c11205fa8ac4ea35fbf79f890e3.tar.bz2
add comment on the classes
Diffstat (limited to 'src')
-rw-r--r--src/org/broeuschmeul/android/gps/bluetooth/provider/BlueetoothGpsManager.java6
-rw-r--r--src/org/broeuschmeul/android/gps/nmea/util/NmeaParser.java8
-rw-r--r--src/org/broeuschmeul/android/gps/sirf/util/SirfUtils.java13
3 files changed, 27 insertions, 0 deletions
diff --git a/src/org/broeuschmeul/android/gps/bluetooth/provider/BlueetoothGpsManager.java b/src/org/broeuschmeul/android/gps/bluetooth/provider/BlueetoothGpsManager.java
index 0d2207d..97a5fa3 100644
--- a/src/org/broeuschmeul/android/gps/bluetooth/provider/BlueetoothGpsManager.java
+++ b/src/org/broeuschmeul/android/gps/bluetooth/provider/BlueetoothGpsManager.java
@@ -56,6 +56,12 @@ import android.provider.Settings;
import android.os.SystemClock;
import android.util.Log;
+/**
+ * This class is used to establish and manage the connection with the bluetooth GPS.
+ *
+ * @author Herbert von Broeuschmeul
+ *
+ */
public class BlueetoothGpsManager {
private static final String LOG_TAG = "BlueGPS";
diff --git a/src/org/broeuschmeul/android/gps/nmea/util/NmeaParser.java b/src/org/broeuschmeul/android/gps/nmea/util/NmeaParser.java
index 32f75a8..792a6ba 100644
--- a/src/org/broeuschmeul/android/gps/nmea/util/NmeaParser.java
+++ b/src/org/broeuschmeul/android/gps/nmea/util/NmeaParser.java
@@ -35,6 +35,14 @@ import android.text.TextUtils;
import android.text.TextUtils.SimpleStringSplitter;
import android.util.Log;
+/**
+ * This class is used to parse NMEA sentences an generate the Android Locations when there is a new GPS FIX.
+ * It manage also the Mock Location Provider (enable/disable/fix & status notification)
+ * and can compute the the checksum of a NMEA sentence.
+ *
+ * @author Herbert von Broeuschmeul
+ *
+ */
public class NmeaParser {
private static final String LOG_TAG = "BlueGPS";
// private static final String LOG_TAG = NmeaParser.class.getSimpleName();
diff --git a/src/org/broeuschmeul/android/gps/sirf/util/SirfUtils.java b/src/org/broeuschmeul/android/gps/sirf/util/SirfUtils.java
index 075322f..65e6b44 100644
--- a/src/org/broeuschmeul/android/gps/sirf/util/SirfUtils.java
+++ b/src/org/broeuschmeul/android/gps/sirf/util/SirfUtils.java
@@ -25,6 +25,19 @@ import java.nio.ByteBuffer;
import java.util.Formatter;
import java.util.Locale;
+/**
+ * Utilities for generation of SIRF III binary command.
+ *
+ * It can be used to generate a array of byte corresponding
+ * to a SIRF III binary command expressed in an hexadecimal string.
+ *
+ * The input can be a complete SIRF III command or just the payload.
+ * In this last case the utility will add the start and end parts of the command
+ * (including the size and the checksum).
+ *
+ * @author Herbert von Broeuschmeul
+ *
+ */
public class SirfUtils {
private static final String start ="A0A2";