aboutsummaryrefslogtreecommitdiffstats
path: root/libtellurian.h
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--libtellurian.h54
-rw-r--r--libtellurian.h.04
2 files changed, 29 insertions, 29 deletions
diff --git a/libtellurian.h b/libtellurian.h
index 98309be..e96cfec 100644
--- a/libtellurian.h
+++ b/libtellurian.h
@@ -64,7 +64,7 @@
/**
* The circumference, in meters, of a sphere inscribed in the Earth's
- * spheroid and intersecting with it's pole (the circumference of
+ * spheroid and intersecting with its pole (the circumference of
* a circle with Earth's polar radius)
*/
#define LIBTELLURIAN_POLAR_CIRCUMFERENCE 39940652.74224401 /* 2bπ */
@@ -123,10 +123,10 @@
* The geocentric gravitational constant, in cubic meters per square second
*
* This is the (universal) gravitational constant (6.67430e-11) multiplied
- * by the mass of the Earth, however this value more reliable that the
- * gravitation constant and the mass of th Earth, and should thus be used
- * instead of multiplying the universial gravitational constant with the
- * the msas of the Earth
+ * by the mass of the Earth; however, this value is more reliable than the
+ * gravitational constant and the mass of the Earth. It should therefore be used
+ * instead of multiplying the universal gravitational constant by the mass of
+ * the Earth.
*/
#define LIBTELLURIAN_GEOCENTRIC_GRAVITATIONAL_CONSTANT 3.986004418e14
@@ -168,7 +168,7 @@ double libtellurian_sea_level_radians(double latitude);
/**
* Calculate the distance between two points on the Earth's surface
*
- * This function is gives an approximate value using
+ * This function gives an approximate value using
* a sphere as a model for the Earth
*
* @param latitude1 GPS latitude coordinate for the first point, in degrees
@@ -184,7 +184,7 @@ double libtellurian_coarse_distance(double latitude1, double longitude1,
/**
* Calculate the distance between two points on the Earth's surface
*
- * This function is gives an approximate value using
+ * This function gives an approximate value using
* a sphere as a model for the Earth
*
* @param latitude1 GPS latitude coordinate for the first point, in radians
@@ -200,7 +200,7 @@ double libtellurian_coarse_distance_radians(double latitude1, double longitude1,
/**
* Calculate the distance and azimuths between two points on the Earth's surface
*
- * This function is gives good approximate values
+ * This function gives good approximate values
* using an oblate spheroid as a model for the Earth
*
* @param latitude1 GPS latitude coordinate for the starting point, in degrees
@@ -213,18 +213,18 @@ double libtellurian_coarse_distance_radians(double latitude1, double longitude1,
* at the end point; or `NULL`
* @return Approximate distance between the two points
*
- * Calculating the the forward azimuths is not free, but it
+ * Calculating the forward azimuths is not free, but it
* is cheap to compute them (especially the first one) when
* most of the computations for the distance have been
* performed. If you have no need for an azimuth you can set
* the corresponding output parameter to `NULL`, and the
* function will not compute it.
*
- * If the two points are they same, the distance will be 0
+ * If the two points are the same, the distance will be 0
* and the azimuths will be NaN, denoting that any direction
* can be taken. If the two points are antipodal, the distance
* will be `LIBTELLURIAN_MERIDIONAL_CIRCUMFERENCE` and the
- * azimuths will be NaN denoting that are multiple directions
+ * azimuths will be NaN denoting that there are multiple directions
* to take, specifying either any (if the two points are the
* poles) or either north or south (and the two azimuths shall
* be the opposite of each other).
@@ -237,7 +237,7 @@ double libtellurian_distance(double latitude1, double longitude1,
/**
* Calculate the distance and azimuths between two points on the Earth's surface
*
- * This function is gives good approximate values
+ * This function gives good approximate values
* using an oblate spheroid as a model for the Earth
*
* @param latitude1 GPS latitude coordinate for the starting point, in radians
@@ -250,18 +250,18 @@ double libtellurian_distance(double latitude1, double longitude1,
* at the end point; or `NULL`
* @return Approximate distance between the two points
*
- * Calculating the the forward azimuths is not free, but it
+ * Calculating the forward azimuths is not free, but it
* is cheap to compute them (especially the first one) when
* most of the computations for the distance have been
* performed. If you have no need for an azimuth you can set
* the corresponding output parameter to `NULL`, and the
* function will not compute it.
*
- * If the two points are they same, the distance will be 0
+ * If the two points are the same, the distance will be 0
* and the azimuths will be NaN, denoting that any direction
* can be taken. If the two points are antipodal, the distance
* will be `LIBTELLURIAN_MERIDIONAL_CIRCUMFERENCE` and the
- * azimuths will be NaN denoting that are multiple directions
+ * azimuths will be NaN denoting that there are multiple directions
* to take, specifying either any (if the two points are the
* poles) or either north or south (and the two azimuths shall
* be the opposite of each other).
@@ -274,7 +274,7 @@ double libtellurian_distance_radians(double latitude1, double longitude1,
/**
* Calculate the azimuths between two points on the Earth's surface
*
- * This function is gives good approximate values
+ * This function gives good approximate values
* using an oblate spheroid as a model for the Earth
*
* @param latitude1 GPS latitude coordinate for the starting point, in degrees
@@ -286,13 +286,13 @@ double libtellurian_distance_radians(double latitude1, double longitude1,
* @param azimuth2_out Output parameter for the forward azimuth, in degrees,
* at the end point; or `NULL`
*
- * This function is identical to libtellurian_distance`
+ * This function is identical to `libtellurian_distance`.
* except it does not compute the distance between the
* points
*
- * If the two points are they same, the azimuths will be NaN,
+ * If the two points are the same, the azimuths will be NaN,
* denoting that any direction can be taken. If the two points
- * are antipodal, the azimuths will be NaN denoting that are
+ * are antipodal, the azimuths will be NaN denoting that there are
* multiple directions to take, specifying either any (if the
* two points are the poles) or either north or south (and
* the two azimuths shall be the opposite of each other).
@@ -304,7 +304,7 @@ void libtellurian_azimuth(double latitude1, double longitude1,
/**
* Calculate the azimuths between two points on the Earth's surface
*
- * This function is gives good approximate values
+ * This function gives good approximate values
* using an oblate spheroid as a model for the Earth
*
* @param latitude1 GPS latitude coordinate for the starting point, in radians
@@ -317,12 +317,12 @@ void libtellurian_azimuth(double latitude1, double longitude1,
* at the end point; or `NULL`
*
*
- * This function is identical to libtellurian_distance_radians`
+ * This function is identical to `libtellurian_distance_radians`.
* except it does not compute the distance between the points
*
- * If the two points are they same, the azimuths will be NaN,
+ * If the two points are the same, the azimuths will be NaN,
* denoting that any direction can be taken. If the two points
- * are antipodal, the azimuths will be NaN denoting that are
+ * are antipodal, the azimuths will be NaN denoting that there are
* multiple directions to take, specifying either any (if the
* two points are the poles) or either north or south (and
* the two azimuths shall be the opposite of each other).
@@ -369,7 +369,7 @@ void libtellurian_end_point_radians(double latitude1, double longitude1, double
/**
* Calculate the normal gravity for some point on
- * the Earth's surface, where the Earth's is model
+ * the Earth's surface, where the Earth is modelled
* as an oblate spheroid
*
* @param latitude GPS latitude coordinate, in degrees
@@ -380,7 +380,7 @@ double libtellurian_normal_gravity(double latitude);
/**
* Calculate the normal gravity for some point on
- * the Earth's surface, where the Earth's is model
+ * the Earth's surface, where the Earth is modelled
* as an oblate spheroid
*
* @param latitude GPS latitude coordinate, in radians
@@ -417,7 +417,7 @@ double libtellurian_effective_gravity_radians(double gravity, double latitude);
/**
* Calculate the gravity adjusted for the elevation
- * above the altitude where the gravity is measure
+ * above the altitude where the gravity is measured
*
* Altitudes above circa 100000 meters is out of range
* for this function (that would be in outer space)
@@ -432,7 +432,7 @@ double libtellurian_elevated_gravity(double gravity, double latitude, double alt
/**
* Calculate the gravity adjusted for the elevation
- * above the altitude where the gravity is measure
+ * above the altitude where the gravity is measured
*
* Altitudes above circa 100000 meters is out of range
* for this function (that would be in outer space)
diff --git a/libtellurian.h.0 b/libtellurian.h.0
index 472d35c..5907df9 100644
--- a/libtellurian.h.0
+++ b/libtellurian.h.0
@@ -1,8 +1,8 @@
-.TH LIBTELLURIAN.H 0 libtellurian
+.TH LIBTELLURIAN.H 0 LIBTELLURIAN
.SH NAME
libtellurian.h \- Geodesy library header
-.SH SYNPOSIS
+.SH SYNOPSIS
.nf
#include <libtellurian.h>