First version of internals documentation.

1 files changed, 57 insertions, 0 deletions

diff --git a/doc/explan_rtcm.c.xml b/doc/explan_rtcm.c.xml
new file mode 100644
index 00000000..690dc323
--- /dev/null
+++ b/doc/explan_rtcm.c.xml
@@ -0,0 +1,57 @@
+<sect1 id="rtcm.c"><title><filename>rtcm.c</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>Functions:-</entry><entry>This is a decoder for the RTCM-104 serial protocol.</entry>
+</row>
+</thead>
+
+<tbody>
+<row>
+  <entry><function>void rtcm_unpack(struct rtcm_t *tp, char *buf)</function></entry>
+  <entry><para>Splits RTCM raw data into fields.</para></entry>
+</row>
+<row>
+  <entry><function>bool rtcm_repack(struct rtcm_t *tp, isgps30bits_t *buf)</function></entry>
+  <entry><para>Packs RTCM fields into a raw data stream.</para></entry>
+</row>
+<row>
+  <entry><function>static bool preamble_match(isgps30bits_t *w)</function></entry>
+  <entry><para>Tells if the preamble field in a message is valid or not.</para></entry>
+</row>
+<row>
+  <entry><function>static bool length_check(struct gps_packet_t *lexer)</function></entry>
+  <entry><para>Tells if the message length is valid or not.</para></entry>
+</row>
+<row>
+  <entry><function>enum isgpsstat_t rtcm_decode(struct gps_packet_t *lexer, unsigned int c)</function></entry>
+  <entry><para>A simple call to <function>isgps_decode()</function>.</para></entry>
+</row>
+<row>
+  <entry><function>void rtcm_dump(struct rtcm_t *rtcm, char buf[], size_t buflen)</function></entry>
+  <entry><para>Dump the contents of a parsed RTCM104 message.</para></entry>
+</row>
+<row>
+  <entry><function>int rtcm_undump(struct rtcm_t *rtcmp, char *buf)</function></entry>
+  <entry><para>Merge a line of data into an RTCM structure, return 0 if done.</para></entry>
+</row>
+<row>
+  <entry><function>void rtcm_output_magnavox(isgps30bits_t *ip, FILE *fp)</function></entry>
+  <entry><para>Ship an RTCM message in the format emitted by Magnavox DGPS receivers.</para></entry>
+</row>
+</tbody>
+
+<tfoot>
+<row>
+  <entry spanname='s1' align='left'>Notes based on <function>$Id: rtcm.c 4065 2006-12-04 05:31:59Z esr $</function></entry>
+</row>
+</tfoot>
+
+</tgroup>
+</informaltable>
+</sect1>