diff options
| author | Mattias Andrée <m@maandree.se> | 2024-10-22 22:22:41 +0200 |
|---|---|---|
| committer | Mattias Andrée <m@maandree.se> | 2024-10-22 22:22:41 +0200 |
| commit | bb5de3aa2ee118df78f0347cffd4e58f846dc1fb (patch) | |
| tree | b313a20b79d67f35a5e4e05bc9106b22dc17f451 /libtellurian_distance.3 | |
| parent | ... (diff) | |
| download | libtellurian-master.tar.gz libtellurian-master.tar.bz2 libtellurian-master.tar.xz | |
Signed-off-by: Mattias Andrée <m@maandree.se>
Diffstat (limited to '')
| -rw-r--r-- | libtellurian_distance.3 | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/libtellurian_distance.3 b/libtellurian_distance.3 index fc753af..d477f53 100644 --- a/libtellurian_distance.3 +++ b/libtellurian_distance.3 @@ -104,6 +104,29 @@ functions do not return any value. .SH ERRORS None. +.SH APPLICATION USAGE +The application should use +.BR libtellurian_azimuth () +or +.BR libtellurian_azimuth_radians () +whenever the distance will not be used by the +application, likewise, if +.I *azimuth1_out +will not be used +.I azimuth1_out +should be set to +.I NULL +and if +.I *azimuth2_out +will not be used +.I azimuth2_out +should be set to +.IR NULL . +Although this currently has almost no impact on +the application, future versions of the library +may select different methods for performing the +calculations depending on what output is enabled. + .SH NOTES The (forward) azimuths are defined as the direction you travelling when you travel |