From bb5de3aa2ee118df78f0347cffd4e58f846dc1fb Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Tue, 22 Oct 2024 22:22:41 +0200 Subject: ... MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- libtellurian_distance.3 | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) (limited to 'libtellurian_distance.3') 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 -- cgit v1.2.3-70-g09d2