deg_to_str2(): Add new function. Thread safe, handles suffix.

1 files changed, 18 insertions, 0 deletions

diff --git a/doc/explan_gpsdclient.c.xml b/doc/explan_gpsdclient.c.xml
index babd2499..4825fd3d 100644
--- a/doc/explan_gpsdclient.c.xml
+++ b/doc/explan_gpsdclient.c.xml
@@ -33,6 +33,24 @@
   </entry>
 </row>
 <row>
+  <entry>
+    <function>char *deg_to_str2(enum deg_str_type type, double f, char *buf,
+    unsigned int buf_size, const char *suffix_pos, const char *suffix_neg)
+    </function>
+  </entry>
+  <entry>
+    <para>Convert the absolute value of double degrees to a string
+    and place in the buffer "buf".  Return a pointer to the buffer.
+    "buf_size" is the size of the buffer.</para>
+    <para>Makes a simple check on invalid degree values (not more
+    than 360) and returns "nan" on error.</para>
+    <para>For valid values, it generates the appropriate string according
+    to the string type enumeration: dd, ddmm or ddmmss.  If the
+    degrees are positive, append "suffix_pos", else append "suffix_neg".
+    </para>
+  </entry>
+</row>
+<row>
   <entry><function>enum unit gpsd_units(void)</function></entry>
   <entry><para>Simple check of the environment to determine what units are required. If all else fails, use compiled in units.</para></entry>
 </row>