summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorGary E. Miller <gem@rellim.com>2019-02-22 15:44:05 -0800
committerGary E. Miller <gem@rellim.com>2019-02-22 15:44:05 -0800
commitf1be39110e39e5c8d095200231a75aea3afecd57 (patch)
tree77d43f78b8235d2a9e085d80c3a2631d12505d03 /doc
parent1db29a3fa49eca5929ba03346eac7cd49f58e86d (diff)
downloadgpsd-f1be39110e39e5c8d095200231a75aea3afecd57.tar.gz
deg_to_s() and calls to it: Allow negative degrees, use fabs().
Every call to deg_to_s() was preceded by a fabs(deg). So move the fabs() into deg_to_s().
Diffstat (limited to 'doc')
-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>