summaryrefslogtreecommitdiff
path: root/doc/explan_gpsdclient.c.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/explan_gpsdclient.c.xml')
-rw-r--r--doc/explan_gpsdclient.c.xml14
1 files changed, 12 insertions, 2 deletions
diff --git a/doc/explan_gpsdclient.c.xml b/doc/explan_gpsdclient.c.xml
index 98ef22fa..babd2499 100644
--- a/doc/explan_gpsdclient.c.xml
+++ b/doc/explan_gpsdclient.c.xml
@@ -19,8 +19,18 @@
<tbody>
<row>
- <entry><function>char *deg_to_str( enum deg_str_type type, double f)</function></entry>
- <entry><para>Convert double degrees to a static string and return a pointer to it.</para><para>Makes a simple check on invalid degree values (less than 0 or more than 360) and returns "nan" if found.</para><para>For valid values, it generates the appropriate string according to the string type enumeration, defaulting to DD MM SS.sss</para></entry>
+ <entry>
+ <function>char *deg_to_str(enum deg_str_type type, double f)</function>
+ </entry>
+ <entry>
+ <para>Convert the absolute value of double degrees to a static string
+ and return a pointer to it.</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.</para>
+ <para>Warning: not thread safe.</para>
+ </entry>
</row>
<row>
<entry><function>enum unit gpsd_units(void)</function></entry>