First version of internals documentation.

1 files changed, 37 insertions, 0 deletions

diff --git a/doc/explan_gps.h.xml b/doc/explan_gps.h.xml
new file mode 100644
index 00000000..ac08310a
--- /dev/null
+++ b/doc/explan_gps.h.xml
@@ -0,0 +1,37 @@
+<sect1 id="gps.h"><title><filename>gps.h</filename></title>
+<informaltable frame='all' pgwide='1'>
+<tgroup cols='2'>
+<colspec colname='c1'></colspec>
+<colspec colname='c2'></colspec>
+<spanspec spanname='s1' namest='c1' nameend='c2'></spanspec>
+
+<thead>
+<row>
+  <entry>Structures:-</entry><entry>The interface of the libgps library, provides data structures the library needs and that the daemon fills.</entry>
+</row>
+</thead>
+
+<tbody>
+<row>
+  <entry><function>struct gps_fix_t {}</function></entry>
+  <entry><para>This is the fix related data gathered from the gps device. Each client session has 2, the current fix and the previous fix.</para></entry>
+</row>
+<row>
+  <entry><function>struct rtcm_t {}</function></entry>
+  <entry><para>This holds the data being processed by the rtcm functions.</para></entry>
+</row>
+<row>
+  <entry><function>struct gps_data_t {}</function></entry>
+  <entry><para>This contains ALL the data available from the daemon; the actual fix, status flags, headings etc. Basically any good stuff that we might want goes here.</para></entry>
+</row>
+</tbody>
+
+<tfoot>
+<row>
+  <entry spanname='s1' align='left'>Notes based on <function>$Id: gps.h 4284 2007-01-27 07:27:42Z ckuethe $</function></entry>
+</row>
+</tfoot>
+
+</tgroup>
+</informaltable>
+</sect1>