First version of internals documentation.

1 files changed, 41 insertions, 0 deletions

diff --git a/doc/explan_gpsd.h.xml b/doc/explan_gpsd.h.xml
new file mode 100644
index 00000000..736d83fb
--- /dev/null
+++ b/doc/explan_gpsd.h.xml
@@ -0,0 +1,41 @@
+<sect1 id="gpsd.h"><title><filename>gpsd.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>Provides fundamental types and structures for the GPS daemon. Only key structures are analysed here. Simple definitions and prototype definitions are ignored.</entry>
+</row>
+</thead>
+
+<tbody>
+<row>
+  <entry><function>struct gps_packet_t {}</function></entry>
+  <entry><para>Provides the data structure used by <function>packet_getter()</function>. 1 per <application>gpsd</application> session.</para></entry>
+</row>
+<row>
+  <entry><function>struct gps_context_t {}</function></entry>
+  <entry><para>Provides context data like number of good fixes seen. 1 per <application>gpsd</application> session.</para></entry>
+</row>
+<row>
+  <entry><function>struct gps_type_t {}</function></entry>
+  <entry><para>This is the method table that every driver uses to communicate with the daemon. It is a table of entry points or externally visible data. 1 per driver type.</para></entry>
+</row>
+<row>
+  <entry><function>struct gps_device_t {}</function></entry>
+  <entry><para>This is the data belonging to a session (global state) and also private storage for the session's associated device driver (if needed). 1 per <application>gpsd</application> session.</para></entry>
+</row>
+</tbody>
+
+<tfoot>
+<row>
+  <entry spanname='s1' align='left'>Notes based on <function>$Id: gpsd.h 4304 2007-03-14 06:07:46Z ckuethe $</function></entry>
+</row>
+</tfoot>
+
+</tgroup>
+</informaltable>
+</sect1>