aboutsummaryrefslogtreecommitdiffstats
path: root/libred.h
diff options
context:
space:
mode:
authorMattias Andrée <m@maandree.se>2026-02-22 14:31:55 +0100
committerMattias Andrée <m@maandree.se>2026-02-22 14:31:55 +0100
commit56ef05de70fd5bf74ba34959b46ed033bbac76a7 (patch)
treeb5c1fc6fc8b42ec83137096e2bfce0c9b264b342 /libred.h
parentlibred_get_colour.3: update grammar (diff)
downloadlibred-56ef05de70fd5bf74ba34959b46ed033bbac76a7.tar.gz
libred-56ef05de70fd5bf74ba34959b46ed033bbac76a7.tar.bz2
libred-56ef05de70fd5bf74ba34959b46ed033bbac76a7.tar.xz
msic fixes
Signed-off-by: Mattias Andrée <m@maandree.se>
Diffstat (limited to '')
-rw-r--r--libred.h10
-rw-r--r--libred.h.018
2 files changed, 14 insertions, 14 deletions
diff --git a/libred.h b/libred.h
index 9d59d39..cb41b71 100644
--- a/libred.h
+++ b/libred.h
@@ -95,7 +95,7 @@
* Test whether it is amateur astronomical twilight
*
* @param ELEV:double The current elevation
- * @return 1 if is amatuer astronomical twilight, 0 otherwise
+ * @return 1 if is amateur astronomical twilight, 0 otherwise
*/
#define LIBRED_IS_AMATEUR_ASTRONOMICAL_TWILIGHT(ELEV) ((-18.0 <= (ELEV)) && ((ELEV) <= -15.0))
@@ -209,8 +209,8 @@ int libred_check_timetravel(void);
* @param r Output parameter for the “red” value
* @param g Output parameter for the green value
* @param b Output parameter for the blue value
- * @return 0 on succeess, -1 on error
- *
+ * @return 0 on success, -1 on error
+ *
* @throws EDOM The selected temperature is below 1000K
*/
int libred_get_colour(long int, double *, double *, double *);
@@ -246,8 +246,8 @@ int libred_get_colour(long int, double *, double *, double *);
* @param temp The desired colour temperature
* @param x Output parameter for the x value
* @param y Output parameter for the y value
- * @return 0 on succeess, -1 on error
- *
+ * @return 0 on success, -1 on error
+ *
* @throws EDOM The selected temperature is below 1000K
*/
int libred_get_colour_xy(long int, double *, double *);
diff --git a/libred.h.0 b/libred.h.0
index 606e234..ec2d807 100644
--- a/libred.h.0
+++ b/libred.h.0
@@ -19,7 +19,7 @@ and symbolic constants in this header are suitable for use in
.B #if
preprocessing directives.
.PP
-This header defines the follow symbolic constants:
+This header defines the following symbolic constants:
.TP
.B LIBRED_SOLAR_APPARENT_RADIUS
The approximate apparent size of the Sun in degrees. This
@@ -58,13 +58,13 @@ failing and setting
.B errno
to
.BR EDOM .
-Currently this value 1000, hypothetical changes will be very small.
+Currently this value is 1000, hypothetical changes will be very small.
.TP
.B LIBRED_DELTA_TEMPERATURE
-The temperatures differences between sequential colour temperatures
-in the colour temperatures look up table. Currently this value is 100.
+The temperature differences between sequential colour temperatures
+in the colour temperatures lookup table. Currently this value is 100.
.PP
-This header defines the follow macros:
+This header defines the following macros:
.TP
.BR LIBRED_IS_TWILIGHT "(const double)"
Evaluates to 1 if the given expression is between -18.0 and 0.0 (this is,
@@ -74,7 +74,7 @@ and
.BR LIBRED_SOLAR_ELEVATION_SUNSET_SUNRISE ),
inclusively, otherwise, this macro evaluates to 0. The input should be the
Sun's apparent elevation, and the macro evaluates to 1 if it is currently
-twilight. The given expression is evaluted either once or twice, therefore,
+twilight. The given expression is evaluated either once or twice, therefore,
it must not have side-effects.
.TP
.BR LIBRED_IS_CIVIL_TWILIGHT "(const double)"
@@ -85,7 +85,7 @@ and
.BR LIBRED_SOLAR_ELEVATION_SUNSET_SUNRISE ),
inclusively, otherwise, this macro evaluates to 0. The input should be the
Sun's apparent elevation, and the macro evaluates to 1 if it is currently
-civil twilight. The given expression is evaluted either once or twice,
+civil twilight. The given expression is evaluated either once or twice,
therefore, it must not have side-effects.
.TP
.BR LIBRED_IS_NAUTICAL_TWILIGHT "(const double)"
@@ -96,7 +96,7 @@ and
.BR LIBRED_SOLAR_ELEVATION_CIVIL_DUSK_DAWN ),
inclusively, otherwise, this macro evaluates to 0. The input should be the
Sun's apparent elevation, and the macro evaluates to 1 if it is currently
-nautical twilight. The given expression is evaluted either once or twice,
+nautical twilight. The given expression is evaluated either once or twice,
therefore, it must not have side-effects.
.TP
.BR LIBRED_IS_ASTRONOMICAL_TWILIGHT "(const double)"
@@ -107,7 +107,7 @@ and
.BR LIBRED_SOLAR_ELEVATION_NAUTICAL_DUSK_DAWN ),
inclusively, otherwise, this macro evaluates to 0. The input should be the
Sun's apparent elevation, and the macro evaluates to 1 if it is currently
-astronomical twilight. The given expression is evaluted either once or twice,
+astronomical twilight. The given expression is evaluated either once or twice,
therefore, it must not have side-effects.
.PP
Note that the intervals are closed, and hence their boundaries overlap.