solstice-solver

commit 6d506f2cdd00f5148e01a447f0fdfbb3f23b525b
parent e5e169fc2de7a159c3d8d06063e38c1c896ce525
Author: Christophe Coustet <christophe.coustet@meso-star.com>
Date:   Tue,  2 Jun 2026 11:48:00 +0200

Improve comments of the API.

Diffstat:
M
src/ssol.h
 | 
7
++++---

1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/src/ssol.h b/src/ssol.h
@@ -1039,8 +1039,8 @@ ssol_sun_set_direction
   (struct ssol_sun* sun,
    const double direction[3]);
 
-/* Main sun direction defined by location and date.
- * The algorithm must be set first */
+/* Main sun direction defined by location and date using the currently defined
+ * algorithm. */
 SSOL_API res_T
 ssol_sun_set_location_and_date
   (struct ssol_sun* sun,
@@ -1049,7 +1049,8 @@ ssol_sun_set_location_and_date
    const struct tm* date);
 
 /* Set the algorithm used to produce sun direction from location and date.
- * The algorithm must be set before calling ssol_sun_set_location_and_date */
+ * Suns are created with algorithm == SSOL_SUN_DIRECTION_ALGORITHM_MEEUS,
+ * regardless of their type. */
 SSOL_API res_T
 ssol_sun_set_algorithm
   (struct ssol_sun* sun,