diff --git a/Sources/KosherSwift/ComplexZmanimCalendar.swift b/Sources/KosherSwift/ComplexZmanimCalendar.swift
index 9088810..7713855 100644
--- a/Sources/KosherSwift/ComplexZmanimCalendar.swift
+++ b/Sources/KosherSwift/ComplexZmanimCalendar.swift
@@ -555,7 +555,7 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
/**
* Method to return a shaah zmanis (temporal hour) according to the opinion of the Magen Avraham (MGA) based on alos being ``
+ * "https://en.wikipedia.org/wiki/Avraham_Gombinern">Magen Avraham (MGA) based on alos being
* ``getAlos96Zmanis()`` 96 minutes zmaniyos before ``getSunrise()`` This calculation divides the
* day based on the opinion of the MGA that the day runs from dawn to dusk. Dawn for this calculation is 96 minutes
* zmaniyos before sunrise and dusk is 96 minutes zmaniyos after sunset. This day is split into 12
@@ -682,7 +682,7 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
* the day based on the opinion of the MGA that the day runs from dawn to dusk. Dawn for this calculation is
* 120 minutes zmaniyos before sunrise and dusk is 120 minutes zmaniyos after sunset. This day is
* split into 12 equal parts with each part being a shaah zmanis. This is identical to 1/6th of the day from
- * ``getSunrise()`` to``getSunset()`` Since zmanim that use this method are
+ * ``getSunrise()`` to ``getSunset()`` Since zmanim that use this method are
* extremely late or early and at a point when the sky is a long time past the 18° point where the darkest point
* is reached, zmanim that use this should only be used lechumra such as delaying the start of
* nighttime mitzvos.
@@ -757,9 +757,7 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
* "https://en.wikipedia.org/wiki/Yair_Bacharach">Chavas Yair in the Mekor Chaim, Orach Chaim Ch.
* 90, though the Mekor Chaim in Ch. 58 and in the Chut Hashani Cha 97 states that
- * a a person walks 3 and a 1/3 mil in an hour, or an 18-minute mil. Also see the Divrei Malkiel Vol. 4, Ch. 20, page 34) who
+ * a a person walks 3 and a 1/3 mil in an hour, or an 18-minute mil. Also see the Divrei Malkiel Vol. 4, Ch. 20, page 34) who
* mentions the 15 minute mil lechumra by baking matzos. Also see the Maharik Ch. 173 where the questioner quoting the
@@ -769,7 +767,7 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
* 18-minute mil. Time based offset calculations are based on the opinion of the
* Rishonim who stated that the time of the neshef
* (time between dawn and sunrise) does not vary by the time of year or location but purely depends on the time it takes to
- * walk the distance of 4x mil. ``getTzaisGeonim9Point75Degrees()`` is a related zman that is a
+ * walk the distance of 4 x mil. ``getTzaisGeonim9Point75Degrees()`` is a related zman that is a
* degree-based calculation based on 60 minutes.
*
* @return the Date representing the time. If the calculation can't be computed such as in the Arctic
@@ -791,9 +789,8 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
* of a day (12 x 60 = 720) based on the a day being from ``getSeaLevelSunrise()`` to
* ``getSeaLevelSunrise()`` or ``getSunrise()`` to ``getSunset()``
* (depending on the ``isUseElevation()`` setting).
- * The actual calculation is ``getSeaLevelSunrise()`` - (``getShaahZmanisGra()`` * 1.2). This calculation
- * is used in the calendars published by the Hisachdus Harabanim D'Artzos Habris Ve'Canada.
+ * The actual calculation is ``getSeaLevelSunrise()`` - (``getShaahZmanisGra()`` x 1.2). This calculation
+ * is used in the calendars published by the Hisachdus Harabanim D'Artzos Habris Ve'Canada.
*
* @return the Date representing the time. If the calculation can't be computed such as in the Arctic
* Circle where there is at least one day a year where the sun does not rise, and one where it does not set,
@@ -809,8 +806,7 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
* Method to return alos (dawn) calculated using 96 minutes before before ``getSunrise()`` or
* ``getSeaLevelSunrise()`` (depending on the ``isUseElevation()`` setting) that is based
* on the time to walk the distance of 4 Mil at 24 minutes a Mil. Time based offset
- * calculations for alos are based on the opinion of the Rishonim who stated that the time of the Neshef (time between dawn and sunrise) does not vary
+ * calculations for alos are based on the opinion of the Rishonim who stated that the time of the Neshef (time between dawn and sunrise) does not vary
* by the time of year or location but purely depends on the time it takes to walk the distance of 4 Mil.
*
* @return the Date representing the time. If the calculation can't be computed such as in the Arctic
@@ -828,7 +824,7 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
* ``isUseElevation()`` setting). This is based on a 22.5-minute Mil so the time for 4 Mil is 90
* minutes which is 1/8th of a day (12 x 60) / 8 = 90
* The day is calculated from ``getSeaLevelSunrise()`` to ``getSeaLevelSunrise`` or ``getSunrise()`` to ``getSunset()`` (depending on the ``isUseElevation()``)
- * The actual calculation used is ``getSunrise()`` - (``getShaahZmanisGra()`` * 1.5).
+ * The actual calculation used is ``getSunrise()`` - (``getShaahZmanisGra()`` x 1.5).
*
* @return the Date representing the time. If the calculation can't be computed such as in the Arctic
* Circle where there is at least one day a year where the sun does not rise, and one where it does not set,
@@ -846,7 +842,7 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
* ``isUseElevation()`` setting). This is based on a 24-minute Mil so the time for 4 Mil is 96
* minutes which is 1/7.5th of a day (12 x 60 / 7.5 = 96).
* The day is calculated from ``getSeaLevelSunrise()`` to ``getSeaLevelSunrise()`` or ``getSunrise()`` to ``getSunset()`` (depending on the ``isUseElevation()``)
- * The actual calculation used is ``getSunrise()`` - (``getShaahZmanisGra()`` * 1.6).
+ * The actual calculation used is ``getSunrise()`` - (``getShaahZmanisGra()`` x 1.6).
*
* @return the Date representing the time. If the calculation can't be computed such as in the Arctic
* Circle where there is at least one day a year where the sun does not rise, and one where it does not set,
@@ -934,7 +930,7 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
/**
* This method should be used lechumra only and returns alos (dawn) calculated when the sun is
- * ``ZENITH_26_DEGREES 26°`` below the eastern geometric horizon before sunrise. This calculation is based on the same
+ * ``ZENITH_26_DEGREES`` 26° below the eastern geometric horizon before sunrise. This calculation is based on the same
* calculation of ``getAlos120()`` 120 minutes but uses a degree-based calculation instead of 120 exact minutes. This
* calculation is based on the position of the sun 120 minutes before sunrise in Jerusalem around the equinox / equilux, which
@@ -977,8 +973,7 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
/**
* A method to return alos (dawn) calculated when the sun is ``ZENITH_19_DEGREES`` 19° below the
- * eastern geometric horizon before sunrise. This is the Rambam's alos according to Rabbi Moshe Kosower's Rambam's alos according to Rabbi Moshe Kosower's Maaglei Tzedek, page 88, Ayeles Hashachar Vol. I, page 12, Yom Valayla Shel Torah, Ch. 34, p. 222 and
@@ -1204,7 +1199,7 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
* is 3 ``getShaahZmanis16Point1Degrees()`` shaos zmaniyos (solar hours) after
* ``getAlos16Point1Degrees()`` dawn based on the opinion of the MGA that the day is calculated from
* dawn to nightfall with both being 16.1° below sunrise or sunset. This returns the time of
- * 3 * ``getShaahZmanis16Point1Degrees()`` after ``getAlos16Point1Degrees() dawn``
+ * 3 x ``getShaahZmanis16Point1Degrees()`` after ``getAlos16Point1Degrees()`` dawn
*
* @return the Date of the latest zman krias shema. If the calculation can't be computed such
* as northern and southern locations even south of the Arctic Circle and north of the Antarctic Circle
@@ -1240,12 +1235,12 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
/**
* This method returns the latest zman krias shema (time to recite Shema in the morning) according to the
* opinion of the Magen Avraham (MGA) based on
- * alos being ``getAlos72()`` 72 minutes before ``getSunrise()`` This time is 3 ``
- *getShaahZmanis72Minutes() shaos zmaniyos (solar hours) after ``getAlos72()`` dawn based on the opinion
+ * alos being ``getAlos72()`` 72 minutes before ``getSunrise()`` This time is 3
+ * ``getShaahZmanis72Minutes()`` shaos zmaniyos (solar hours) after ``getAlos72()`` dawn based on the opinion
* of the MGA that the day is calculated from a ``getAlos72()`` dawn of 72 minutes before sunrise to
- * ``getTzais72()`` nightfall of 72 minutes after sunset. This returns the time of 3 x ``
+ * ``getTzais72()`` nightfall of 72 minutes after sunset. This returns the time of 3 x
* ``getShaahZmanis72Minutes()`` after ``getAlos72()`` dawn. This class returns an identical time to
- *``getSofZmanShmaMGA()`` and is repeated here for clarity.
+ * ``getSofZmanShmaMGA()`` and is repeated here for clarity.
*
* @return the Date of the latest zman krias shema. If the calculation can't be computed such
* as in the Arctic Circle where there is at least one day a year where the sun does not rise, and one where
@@ -1309,7 +1304,7 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
* opinion of the Magen Avraham (MGA) based
* on alos being ``getAlos90Zmanis()`` 90 minutes zmaniyos before ``getSunrise()``
* sunrise This time is 3 ``getShaahZmanis90MinutesZmanis()``shaos zmaniyos (solar hours) after
- * ``getAlos90Zmanis()`` dawn based on the opinion of the MGA that the day is calculated from a ``
+ * ``getAlos90Zmanis()`` dawn based on the opinion of the MGA that the day is calculated from a
* ``getAlos90Zmanis()`` dawn of 90 minutes zmaniyos before sunrise to ``getTzais90Zmanis()`` nightfall
* of 90 minutes zmaniyos after sunset. This returns the time of 3 x ``getShaahZmanis90MinutesZmanis()``
* after ``getAlos90Zmanis()`` dawn
@@ -1332,7 +1327,7 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
* on alos being ``getAlos96()`` 96 minutes before ``getSunrise()`` This time is 3
* ``getShaahZmanis96Minutes()`` shaos zmaniyos (solar hours) after ``getAlos96()`` dawn based on
* the opinion of the MGA that the day is calculated from a ``getAlos96()`` of 96 minutes before
- * sunrise to ``getTzais96()`` of 96 minutes after sunset. This returns the time of 3 * ``
+ * sunrise to ``getTzais96()`` of 96 minutes after sunset. This returns the time of 3 x
* ``getShaahZmanis96Minutes()`` after ``getAlos96()`` dawn
*
* @return the Date of the latest zman krias shema. If the calculation can't be computed such
@@ -1352,8 +1347,8 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
* opinion of the Magen Avraham (MGA) based
* on alos being ``getAlos90Zmanis()`` 96 minutes zmaniyos before ``getSunrise()``
* sunrise This time is 3 ``getShaahZmanis96MinutesZmanis()`` shaos zmaniyos (solar hours) after
- * ``getAlos96Zmanis()`` dawn based on the opinion of the MGA that the day is calculated from a ``
- *getAlos96Zmanis() dawn of 96 minutes zmaniyos before sunrise to ``getTzais90Zmanis()`` nightfall
+ * ``getAlos96Zmanis()`` dawn based on the opinion of the MGA that the day is calculated from a
+ * ``getAlos96Zmanis()`` dawn of 96 minutes zmaniyos before sunrise to ``getTzais90Zmanis()`` nightfall
* of 96 minutes zmaniyos after sunset. This returns the time of 3 x ``getShaahZmanis96MinutesZmanis()``
* after ``getAlos96Zmanis()`` dawn
*
@@ -1371,7 +1366,7 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
/**
* This method returns the latest zman krias shema (time to recite Shema in the morning) calculated
- * as 3 hours (regular clock hours and not sha'os zmaniyos) before ``ZmanimCalendar#getChatzos()``
+ * as 3 hours (regular clock hours and not sha'os zmaniyos) before ``ZmanimCalendar.getChatzos()``
* Generally known as part of the "Komarno" zmanim after Rav Yitzchak Eizik of
* Komarno, a proponent of this calculation, it actually predates him a lot. It is the opinion of the
@@ -1404,9 +1399,9 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
* This method returns the latest zman krias shema (time to recite Shema in the morning) according to the
* opinion of the Magen Avraham (MGA) based
* on alos being ``getAlos120()`` 120 minutes or 1/6th of the day before ``getSunrise()``
- * This time is 3 ``getShaahZmanis120Minutes()`` shaos zmaniyos (solar hours) after ``getAlos120()
- * dawn based on the opinion of the MGA that the day is calculated from a ``getAlos120()`` dawn of 120 minutes
- * before sunrise to ``getTzais120()`` nightfall of 120 minutes after sunset. This returns the time of 3
+ * This time is 3 ``getShaahZmanis120Minutes()`` shaos zmaniyos (solar hours) after ``getAlos120()``
+ * dawn based on the opinion of the MGA that the day is calculated from ``getAlos120()`` dawn of 120 minutes
+ * before sunrise to ``getTzais120()`` nightfall of 120 minutes after sunset. This returns the time of 3
* ``getShaahZmanis120Minutes()`` after ``getAlos120()`` dawn.
*
* - Warning: This is an extremely early zman that is very much a chumra.
@@ -1425,18 +1420,16 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
/**
* This method returns the latest zman krias shema (time to recite Shema in the morning) based
- * on the opinion that the day starts at ``getAlos16Point1Degrees()`` alos 16.1° and ends at
+ * on the opinion that the day starts at ``getAlos16Point1Degrees()`` alos 16.1° and ends at
* ``getSeaLevelSunset()`` This is the opinion of the \u05D7\u05D9\u05D3\u05D5\u05E9\u05D9
- * \u05D5\u05DB\u05DC\u05DC\u05D5\u05EA \u05D4\u05E8\u05D6\u05F4\u05D4 and the \u05DE\u05E0\u05D5\u05E8\u05D4 \u05D4\u05D8\u05D4\u05D5\u05E8\u05D4 as
- * mentioned by Yisrael Vehazmanim vol 1, sec. 7,
- * ch. 3 no. 16. Three shaos zmaniyos are calculated based on this day and added to ``
- *getAlos16Point1Degrees() alos to reach this time. This time is 3 shaos zmaniyos (solar hours)
- * after ``getAlos16Point1Degrees()`` dawn based on the opinion that the day is calculated from a ``
- *getAlos16Point1Degrees() alos 16.1° to ``getSeaLevelSunset()``
- * Note: Based on this calculation chatzos will not be at midday and ``
- *isUseAstronomicalChatzosForOtherZmanim() will be ignored.
+ * "https://hebrewbooks.org/40357">חידושי וכללות הרז"ה and the מנורה הטהורה as mentioned by Yisrael Vehazmanim vol 1, sec. 7,
+ * ch. 3 no. 16. Three shaos zmaniyos are calculated based on this day and added to
+ * ``getAlos16Point1Degrees()`` alos to reach this time. This time is 3 shaos zmaniyos (solar hours)
+ * after ``getAlos16Point1Degrees()`` dawn based on the opinion that the day is calculated from a
+ * ``getAlos16Point1Degrees()`` alos 16.1° to ``getSeaLevelSunset()``
+ * Note: Based on this calculation chatzos will not be at midday and
+ * ``isUseAstronomicalChatzosForOtherZmanim()`` will be ignored.
*
* @return the Date of the latest zman krias shema based on this day. If the calculation can't
* be computed such as northern and southern locations even south of the Arctic Circle and north of the
@@ -1456,9 +1449,9 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
* based on this day and added to ``getAlos16Point1Degrees()`` alos to reach this time. This time is 3
* shaos zmaniyos (temporal hours) after ``getAlos16Point1Degrees()`` alos 16.1° based on
* the opinion that the day is calculated from a ``getAlos16Point1Degrees()`` alos 16.1° to
- * ``getTzaisGeonim7Point083Degrees()`` tzais 7.083°``
- * Note: Based on this calculation chatzos will not be at midday and ``
- *isUseAstronomicalChatzosForOtherZmanim() will be ignored.
+ * ``getTzaisGeonim7Point083Degrees()`` tzais 7.083°
+ * Note: Based on this calculation chatzos will not be at midday and
+ * ``isUseAstronomicalChatzosForOtherZmanim()`` will be ignored.
*
* @return the Date of the latest zman krias shema based on this calculation. If the
* calculation can't be computed such as northern and southern locations even south of the Arctic Circle and
@@ -1625,8 +1618,8 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
* alos being ``getAlos96()`` 96 minutes before ``getSunrise()`` This time is 4
* ``getShaahZmanis96Minutes()`` shaos zmaniyos (solar hours) after ``getAlos96()`` dawn based on
* the opinion of the MGA that the day is calculated from a ``getAlos96()`` dawn of 96 minutes before
- * sunrise to ``getTzais96()`` nightfall of 96 minutes after sunset. This returns the time of 4 *
- * ``getShaahZmanis96Minutes() after ``getAlos96() dawn``
+ * sunrise to ``getTzais96()`` nightfall of 96 minutes after sunset. This returns the time of 4 x
+ * ``getShaahZmanis96Minutes()`` after ``getAlos96()`` dawn
*
* @return the Date of the latest zman tfila. If the calculation can't be computed such as in
* the Arctic Circle where there is at least one day a year where the sun does not rise, and one where it
@@ -1646,8 +1639,8 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
* 4 ``getShaahZmanis96MinutesZmanis()`` shaos zmaniyos (solar hours) after ``getAlos96Zmanis()``
* dawn based on the opinion of the MGA that the day is calculated from a ``getAlos96Zmanis()`` dawn
* of 96 minutes zmaniyos before sunrise to ``getTzais96Zmanis()`` nightfall of 96 minutes
- * zmaniyos after sunset. This returns the time of 4 * ``getShaahZmanis96MinutesZmanis() after
- * ``getAlos96Zmanis() dawn``
+ * zmaniyos after sunset. This returns the time of 4 x ``getShaahZmanis96MinutesZmanis()`` after
+ * ``getAlos96Zmanis()`` dawn
*
* @return the Date of the latest zman krias shema. If the calculation can't be computed such
* as in the Arctic Circle where there is at least one day a year where the sun does not rise, and one where
@@ -1667,7 +1660,7 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
* ``getShaahZmanis120Minutes()`` shaos zmaniyos (solar hours) after ``getAlos120()`` dawn
* based on the opinion of the MGA that the day is calculated from a ``getAlos120()`` dawn of 120
* minutes before sunrise to ``getTzais120()`` nightfall of 120 minutes after sunset. This returns the time of
- * 4 * ``getShaahZmanis120Minutes() after ``getAlos120() dawn`` This is an extremely early zman
+ * 4 x ``getShaahZmanis120Minutes()`` after ``getAlos120()`` dawn. This is an extremely early zman
* that is very much a chumra.
*
* @return the Date of the latest zman krias shema. If the calculation can't be computed such
@@ -1704,7 +1697,7 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
* calculated by ``getMinchaGedola()`` Some use this time to delay the start of mincha in the winter when
* 1/2 of a ``getShaahZmanisGra()`` shaah zmanis is less than 30 minutes. See
* ``getMinchaGedolaGreaterThan30()`` for a convenience method that returns the later of the 2 calculations. One
- * should not use this time to start mincha before the standard ``getMinchaGedola()`` mincha gedola``
+ * should not use this time to start mincha before the standard ``getMinchaGedola()`` mincha gedola
* See Shulchan Aruch Orach Chayim 234:1 and
* the Shaar Hatziyon seif katan ches. Since this calculation is a fixed 30 minutes of regular clock time after
* chatzos, even if ``isUseAstronomicalChatzosForOtherZmanim()`` is false, this mincha
@@ -1785,11 +1778,11 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
* "https://en.wikipedia.org/wiki/Yaakov_Moshe_Hillel">Rabbi Yaakov Moshe Hillel as published in the luach
* of the Bais Horaah of Yeshivat Chevrat Ahavat Shalom that mincha gedola is calculated as half a shaah
* zmanis after chatzos with shaos zmaniyos calculated based on a day starting 72 minutes befoe sunrise
- * ``getAlos16Point1Degrees()`` alos 16.1° and ending 13.5 minutes after sunset ``
+ * ``getAlos16Point1Degrees()`` alos 16.1° and ending 13.5 minutes after sunset
* ``getTzaisGeonim3Point7Degrees()`` tzais 3.7° Mincha gedola is the earliest time to pray mincha.
* The later of this time or 30 clock minutes after chatzos is returned. See ``getMinchaGedolaGreaterThan30()``
* (though that calculation is based on mincha gedola GRA).
- * For more information about mincha gedola see the documentation on ``getMinchaGedola()`` mincha gedola``
+ * For more information about mincha gedola see the documentation on ``getMinchaGedola()`` mincha gedola
* Since calculation of this zman involves chatzos that is offset from the center of the astronomical day,
* ``isUseAstronomicalChatzosForOtherZmanim()`` is N/A here.
* @return the Date of the mincha gedola. If the calculation can't be computed such as northern and
@@ -1850,7 +1843,7 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
* opinion of the Rambam and others. For more information on
* this see the documentation on ``getMinchaGedola()`` mincha gedola This is calculated as 9.5
* ``getTemporalHour()`` solar hours after alos. The calculation used is 9.5 x
- * ``getShaahZmanis16Point1Degrees()`` after ``getAlos16Point1Degrees()`` alos``
+ * ``getShaahZmanis16Point1Degrees()`` after ``getAlos16Point1Degrees()`` alos
*
* @see getShaahZmanis16Point1Degrees()
* @see getMinchaGedola()
@@ -1872,7 +1865,7 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
* calculated based on a day starting at ``getAlos16Point1Degrees()`` alos 16.1° and ending at
* tzais 3.8°. Mincha ketana is the preferred earliest time to pray mincha according to
* the opinion of the Rambam and others. For more information
- * on this see the documentation on ``getMinchaKetana()`` mincha ketana``
+ * on this see the documentation on ``getMinchaKetana()`` mincha ketana
*
* @return the the Date of the time of mincha ketana. If the calculation can't be computed such as
* northern and southern locations even south of the Arctic Circle and north of the Antarctic Circle where the
@@ -1893,9 +1886,9 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
* This method returns the time of mincha ketana according to the Magen Avraham with the day
* starting 72 minutes before sunrise and ending 72 minutes after sunset. This is the preferred earliest time to pray
* mincha according to the opinion of the Rambam
- * and others. For more information on this see the documentation on ``getMinchaGedola()`` mincha gedola``
+ * and others. For more information on this see the documentation on ``getMinchaGedola()`` mincha gedola
* This is calculated as 9.5 ``getShaahZmanis72Minutes()`` after alos. The calculation used is 9.5 x
- * ``getShaahZmanis72Minutes()`` after ``getAlos72()`` alos``
+ * ``getShaahZmanis72Minutes()`` after ``getAlos72()`` alos
*
* @see getShaahZmanis16Point1Degrees()
* @see getMinchaGedola()
@@ -1946,7 +1939,6 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
*
* @see getShaahZmanis72Minutes()
*/
- //@Deprecated // (forRemoval=false) // add back once Java 9 is the minimum supported version
public func getPlagHamincha72Minutes() -> Date? {
return getPlagHamincha(startOfDay: getAlos72(), endOfDay: getTzais72(), synchronous: true);
}
@@ -1970,7 +1962,6 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
*
* @see getShaahZmanis90Minutes()
*/
- //@Deprecated // (forRemoval=false) // add back once Java 9 is the minimum supported version
public func getPlagHamincha90Minutes() -> Date? {
return getPlagHamincha(startOfDay: getAlos90(), endOfDay: getTzais90(), synchronous: true);
}
@@ -1993,14 +1984,13 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
* ``AstronomicalCalendar`` documentation.
* @see getShaahZmanis96Minutes()
*/
- //@Deprecated // (forRemoval=false) // add back once Java 9 is the minimum supported version
public func getPlagHamincha96Minutes() -> Date? {
return getPlagHamincha(startOfDay: getAlos96(), endOfDay: getTzais96(), synchronous: true);
}
/**
* This method should be used lechumra only and returns the time of plag hamincha. This is calculated
- * as 10.75 hours after ``getAlos96Zmanis()`` dawn The formula used is 10.75 x ``
+ * as 10.75 hours after ``getAlos96Zmanis()`` dawn The formula used is 10.75 x
*``getShaahZmanis96MinutesZmanis()`` after ``getAlos96Zmanis()`` dawn. Since plag by this calculation can
* occur after sunset, it should only be used lechumra.
*
@@ -2014,7 +2004,6 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
* does not set, a nil will be returned. See detailed explanation on top of the
* ``AstronomicalCalendar`` documentation.
*/
- //@Deprecated // (forRemoval=false) // add back once Java 9 is the minimum supported version
public func getPlagHamincha96MinutesZmanis() -> Date? {
return getPlagHamincha(startOfDay: getAlos96Zmanis(), endOfDay: getTzais96Zmanis(), synchronous: true);
}
@@ -2035,7 +2024,6 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
* does not set, a nil will be returned. See detailed explanation on top of the
* ``AstronomicalCalendar`` documentation.
*/
- //@Deprecated // (forRemoval=false) // add back once Java 9 is the minimum supported version
public func getPlagHamincha90MinutesZmanis() -> Date? {
return getPlagHamincha(startOfDay: getAlos90Zmanis(), endOfDay: getTzais90Zmanis(), synchronous: true);
}
@@ -2056,7 +2044,6 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
* does not set, a nil will be returned. See detailed explanation on top of the
* ``AstronomicalCalendar`` documentation.
*/
- //@Deprecated // (forRemoval=false) // add back once Java 9 is the minimum supported version
public func getPlagHamincha72MinutesZmanis() -> Date? {
return getPlagHamincha(startOfDay: getAlos72Zmanis(), endOfDay: getTzais72Zmanis(), synchronous: true);
}
@@ -2081,15 +2068,14 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
*
* @see getShaahZmanis16Point1Degrees()
*/
- //@Deprecated // (forRemoval=false) // add back once Java 9 is the minimum supported version
public func getPlagHamincha16Point1Degrees() -> Date? {
return getPlagHamincha(startOfDay: getAlos16Point1Degrees(), endOfDay: getTzais16Point1Degrees(), synchronous: true);
}
/**
* This method should be used lechumra only and returns the time of plag hamincha based on the
- * opinion that the day starts at ``getAlos19Point8Degrees()`` alos 19.8° and ends at ``
- *getTzais19Point8Degrees() tzais 19.8° This is calculated as 10.75 hours zmaniyos
+ * opinion that the day starts at ``getAlos19Point8Degrees()`` alos 19.8° and ends at
+ * ``getTzais19Point8Degrees()`` tzais 19.8° This is calculated as 10.75 hours zmaniyos
* after ``getAlos19Point8Degrees()`` dawn. The formula used is 10.75 x
*``getShaahZmanis19Point8Degrees()`` after ``getAlos19Point8Degrees()`` Since plag by this
* calculation can occur after sunset, it should only be used lechumra.
@@ -2106,7 +2092,6 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
*
* @see getShaahZmanis19Point8Degrees()
*/
- //@Deprecated // (forRemoval=false) // add back once Java 9 is the minimum supported version
public func getPlagHamincha19Point8Degrees() -> Date? {
return getPlagHamincha(startOfDay: getAlos19Point8Degrees(), endOfDay: getTzais19Point8Degrees(), synchronous: true);
}
@@ -2114,9 +2099,9 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
/**
* This method should be used lechumra only and returns the time of plag hamincha based on the
* opinion that the day starts at ``getAlos26Degrees()`` alos 26° and ends at
- *``getTzais26Degrees()`` tzais 26° This is calculated as 10.75 hours zmaniyos after
- *``getAlos26Degrees()`` dawn The formula used is 10.75 x ``getShaahZmanis26Degrees()`` after
- *``getAlos26Degrees()`` Since the zman based on an extremely early alos and a very late
+ * ``getTzais26Degrees()`` tzais 26° This is calculated as 10.75 hours zmaniyos after
+ * ``getAlos26Degrees()`` dawn The formula used is 10.75 x ``getShaahZmanis26Degrees()`` after
+ * ``getAlos26Degrees()`` Since the zman based on an extremely early alos and a very late
* tzais, it should only be used lechumra.
*
* //@Deprecated This method should be used lechumra only since it returns a very late time (often after
@@ -2132,7 +2117,6 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
* @see getShaahZmanis26Degrees()
* @see getPlagHamincha120Minutes()
*/
- //@Deprecated // (forRemoval=false) // add back once Java 9 is the minimum supported version
public func getPlagHamincha26Degrees() -> Date? {
return getPlagHamincha(startOfDay: getAlos26Degrees(), endOfDay: getTzais26Degrees(), synchronous: true);
}
@@ -2140,9 +2124,9 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
/**
* This method should be used lechumra only and returns the time of plag hamincha based on the
* opinion that the day starts at ``getAlos18Degrees()`` alos 18° and ends at
- *``getTzais18Degrees()`` tzais 18° This is calculated as 10.75 hours zmaniyos after
- *``getAlos18Degrees()`` dawn. The formula used is 10.75 x ``getShaahZmanis18Degrees()`` after
- *``getAlos18Degrees()`` Since plag by this calculation can occur after sunset, it should only be used
+ * ``getTzais18Degrees()`` tzais 18° This is calculated as 10.75 hours zmaniyos after
+ * ``getAlos18Degrees()`` dawn. The formula used is 10.75 x ``getShaahZmanis18Degrees()`` after
+ * ``getAlos18Degrees()`` Since plag by this calculation can occur after sunset, it should only be used
* lechumra.
*
* //@Deprecated This method should be used lechumra only since it returns a very late time (often after
@@ -2157,7 +2141,6 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
*
* @see getShaahZmanis18Degrees()
*/
- //@Deprecated // (forRemoval=false) // add back once Java 9 is the minimum supported version
public func getPlagHamincha18Degrees() -> Date? {
return getPlagHamincha(startOfDay: getAlos18Degrees(), endOfDay: getTzais18Degrees(), synchronous: true);
}
@@ -2181,20 +2164,19 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
* @see getAlos16Point1Degrees()
* @see getSeaLevelSunset()
*/
- //@Deprecated // (forRemoval=false) // add back once Java 9 is the minimum supported version
public func getPlagAlosToSunset() -> Date? {
return getPlagHamincha(startOfDay: getAlos16Point1Degrees(), endOfDay: getElevationAdjustedSunset(), synchronous: false);
}
/**
* This method returns the time of plag hamincha based on the opinion that the day starts at
- * ``getAlos16Point1Degrees() alos 16.1° and ends at ``getTzaisGeonim7Point083Degrees()
- * tzais`` 10.75 shaos zmaniyos are calculated based on this day and added to ``
- *getAlos16Point1Degrees() alos to reach this time. This time is 10.75 shaos zmaniyos (temporal
- * hours) after ``getAlos16Point1Degrees() dawn based on the opinion that the day is calculated from a
- * ``getAlos16Point1Degrees() dawn of 16.1 degrees before sunrise to
- * ``getTzaisGeonim7Point083Degrees() tzais . This returns the time of 10.75 * the calculated
- * shaah zmanis after ``getAlos16Point1Degrees() dawn``
+ * ``getAlos16Point1Degrees()`` alos 16.1° and ends at ``getTzaisGeonim7Point083Degrees()``
+ * tzais 10.75 shaos zmaniyos are calculated based on this day and added to
+ * ``getAlos16Point1Degrees()`` alos to reach this time. This time is 10.75 shaos zmaniyos (temporal
+ * hours) after ``getAlos16Point1Degrees()`` dawn based on the opinion that the day is calculated from a
+ * ``getAlos16Point1Degrees()`` dawn of 16.1 degrees before sunrise to
+ * ``getTzaisGeonim7Point083Degrees()`` tzais . This returns the time of 10.75 * the calculated
+ * shaah zmanis after ``getAlos16Point1Degrees()`` dawn
*
* @return the Date of the plag. If the calculation can't be computed such as northern and
* southern locations even south of the Arctic Circle and north of the Antarctic Circle where the sun may not
@@ -2212,8 +2194,8 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
* This method returns the time of plag hamincha (the earliest time that Shabbos can be started) based on the
* opinion of Rabbi Yaakov Moshe Hillel as published in
* the luach of the Bais Horaah of Yeshivat Chevrat Ahavat Shalom that that plag hamincha is calculated
- * as 1.25 shaos zmaniyos before ``getTzaisGeonim3Point8Degrees() tzais 3.8° with shaos
- * zmaniyos calculated based on a day starting at ``getAlos16Point1Degrees() alos 16.1° and
+ * as 1.25 shaos zmaniyos before ``getTzaisGeonim3Point8Degrees()`` tzais 3.8° with shaos
+ * zmaniyos calculated based on a day starting at ``getAlos16Point1Degrees()`` alos 16.1° and
* ending at tzais 3.8°.
*
* @return the Date of the plag. If the calculation can't be computed such as northern and
@@ -2274,7 +2256,7 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
/**
* This method returns the beginning of bain hashmashos based on the calculation of 13.5 minutes (3/4 of an
- * 18-minute Mil) before shkiah calculated as ``getTzaisGeonim7Point083Degrees() 7.083°``.
+ * 18-minute Mil) before shkiah calculated as ``getTzaisGeonim7Point083Degrees()`` 7.083°.
*
* @return the Date of the bain hashmashos of Rabbeinu Tam in this calculation. If the
* calculation can't be computed such as northern and southern locations even south of the Arctic Circle and
@@ -2344,7 +2326,6 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
* in the upcoming 8th edition of the zmanim Kehilchasam. For more details, see the article The Yereim’s Bein Hashmashos.
*
- * @todo recalculate based on equinox/equilux
* @return the Date of the sun's position 3.05° minutes before sunset. If the calculation can't
* be computed such as in the Arctic Circle where there is at least one day a year where the sun does not
* rise, and one where it does not set, a nil will be returned. See detailed explanation on
@@ -2553,7 +2534,7 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
/**
* This method returns the tzais (nightfall) based on the opinion of the Geonim as calculated by
* Rabbi Yechiel Michel Tucazinsky. It is
- * based on of the position of the sun no later than ``getTzaisGeonim6Point45Degrees() 31 minutes after sunset
+ * based on of the position of the sun no later than ``getTzaisGeonim6Point45Degrees()`` 31 minutes after sunset
* in Jerusalem the height of the summer solstice and is 28 minutes after shkiah around the equinox / equilux. This
* computes to 6.45° below the western horizon.
@@ -2616,7 +2597,6 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
* be located). Since this zman depends on the level of light, Rabbi Yaakov Shakow presented this degree-based
* calculation to Rabbi Rabbi Shmuel Kamenetsky who agreed
* to it.
- * @todo add hyperlinks to source of Divrei Shalom once it is located.
* @return the Date representing the time when the sun is 7.67° below sea level. If the
* calculation can't be computed such as northern and southern locations even south of the Arctic Circle and
* north of the Antarctic Circle where the sun may not reach low enough below the horizon for this
@@ -2663,12 +2643,11 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
* minutes after sunset around the equinox / equilux, the
* day that a solar hour is 60 minutes in New York. The sun's position at this time computes to
- * ``ZENITH_9_POINT_75 9.75° below the western horizon. This is the opinion of Rabbi Eliyahu Henkin. This also follows the opinion of
* Rabbi Shmuel Kamenetsky. Rabbi Yaakov Shakow presented
* these degree-based times to Rabbi Shmuel Kamenetsky who agreed to them.
*
- * @todo recalculate based on equinox / equilux.
* @return the Date representing the time when the sun is 9.75° below sea level. If the calculation
* can't be computed such as northern and southern locations even south of the Arctic Circle and north of
* the Antarctic Circle where the sun may not reach low enough below the horizon for this calculation, a
@@ -2684,8 +2663,7 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
/**
* This method returns the tzais (nightfall) based on the opinion of the Chavas Yair and Divrei Malkiel that the time to walk the distance of a Mil is 15 minutes for a total of 60 minutes
+ * "https://he.wikipedia.org/wiki/%D7%9E%D7%9C%D7%9B%D7%99%D7%90%D7%9C_%D7%A6%D7%91%D7%99_%D7%98%D7%A0%D7%A0%D7%91%D7%95%D7%99%D7%9D">Divrei Malkiel that the time to walk the distance of a Mil is 15 minutes for a total of 60 minutes
* for 4 Mil after ``getSeaLevelSunset()`` See detailed documentation explaining the
* 60 minute concept at ``getAlos60()``
*
@@ -2791,7 +2769,7 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
* after sunset (configurable to any offset via ``setAteretTorahSunsetOffset(ateretTorahSunsetOffset:)``). shaos zmaniyos
* are calculated based on this day and added to ``getAlos72Zmanis()`` alos to reach this time. This time
* is 4 x ``getShaahZmanisAteretTorah()`` shaos zmaniyos (temporal hours) after
- * ``getAlos72Zmanis()`` alos 72 zmaniyos``
+ * ``getAlos72Zmanis()`` alos 72 zmaniyos
* Note: Based on this calculation chatzos will not be at midday.
*
* @return the Date of the latest zman krias shema based on this calculation. If the
@@ -2811,11 +2789,11 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
* This method returns the time of mincha gedola based on the calculation of Chacham Yosef
* Harari-Raful of Yeshivat Ateret Torah, that the day starts ``getAlos72Zmanis()`` 1/10th of the day
* before sunrise and is usually calculated as ending ``getTzaisAteretTorah()`` 40 minutes after sunset
- * (configurable to any offset via ``setAteretTorahSunsetOffset(ateretTorahSunsetOffset:))``. This is the preferred earliest
+ * (configurable to any offset via ``setAteretTorahSunsetOffset(ateretTorahSunsetOffset:)``). This is the preferred earliest
* time to pray mincha according to the opinion of the Rambam and others. For more information on this see the documentation on ``getMinchaGedola()`` mincha
* gedola This is calculated as 6.5 ``getShaahZmanisAteretTorah()`` solar hours after alos. The
- * calculation used is 6.5 x ``getShaahZmanisAteretTorah()`` after ``getAlos72Zmanis()`` alos``
+ * calculation used is 6.5 x ``getShaahZmanisAteretTorah()`` after ``getAlos72Zmanis()`` alos
*
* @see getAlos72Zmanis()
* @see getTzaisAteretTorah()
@@ -2838,13 +2816,13 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
/**
* This method returns the time of mincha ketana based on the calculation of
* Chacham Yosef Harari-Raful of Yeshivat Ateret Torah, that the day starts
- * ``getAlos72Zmanis() 1/10th of the day before sunrise and is usually calculated as ending
- * ``getTzaisAteretTorah() 40 minutes after sunset (configurable to any offset via
- * ``setAteretTorahSunsetOffset(double)). This is the preferred earliest time to pray mincha
+ * ``getAlos72Zmanis()`` 1/10th of the day before sunrise and is usually calculated as ending
+ * ``getTzaisAteretTorah()`` 40 minutes after sunset (configurable to any offset via
+ * ``setAteretTorahSunsetOffset(ateretTorahSunsetOffset:)``). This is the preferred earliest time to pray mincha
* according to the opinion of the Rambam and others.
- * For more information on this see the documentation on ``getMinchaGedola() mincha gedola`` This is
- * calculated as 9.5 ``getShaahZmanisAteretTorah() solar hours after ``getAlos72Zmanis() alos``
- * The calculation used is 9.5 x ``getShaahZmanisAteretTorah()`` after ``getAlos72Zmanis()`` alos``
+ * For more information on this see the documentation on ``getMinchaGedola()`` mincha gedola This is
+ * calculated as 9.5 ``getShaahZmanisAteretTorah()`` solar hours after ``getAlos72Zmanis()`` alos
+ * The calculation used is 9.5 x ``getShaahZmanisAteretTorah()`` after ``getAlos72Zmanis()`` alos
*
* @see getAlos72Zmanis()
* @see getTzaisAteretTorah()
@@ -2864,12 +2842,12 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
/**
* This method returns the time of plag hamincha based on the calculation of Chacham Yosef Harari-Raful
- * of Yeshivat Ateret Torah, that the day starts ``getAlos72Zmanis() 1/10th of the day before sunrise and is
- * usually calculated as ending ``getTzaisAteretTorah() 40 minutes after sunset (configurable to any offset
- * via ``setAteretTorahSunsetOffset(double)). shaos zmaniyos are calculated based on this day and
- * added to ``getAlos72Zmanis() alos to reach this time. This time is 10.75
- * ``getShaahZmanisAteretTorah() shaos zmaniyos (temporal hours) after ``getAlos72Zmanis()
- * dawn``
+ * of Yeshivat Ateret Torah, that the day starts ``getAlos72Zmanis()`` 1/10th of the day before sunrise and is
+ * usually calculated as ending ``getTzaisAteretTorah()`` 40 minutes after sunset (configurable to any offset
+ * via ``setAteretTorahSunsetOffset(ateretTorahSunsetOffset:)``). shaos zmaniyos are calculated based on this day and
+ * added to ``getAlos72Zmanis()`` alos to reach this time. This time is 10.75
+ * ``getShaahZmanisAteretTorah()`` shaos zmaniyos (temporal hours) after ``getAlos72Zmanis()``
+ * dawn
*
* @return the Date of the plag. If the calculation can't be computed such as in the Arctic Circle
* where there is at least one day a year where the sun does not rise, and one where it does not set, a nil
@@ -2886,7 +2864,7 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
/**
* Method to return tzais (dusk) calculated as 13.5 minutes zmaniyos after sunset.
- * - Warning: This zman is EXTREMELY early! It is so early that it was removed from KosherJava since it caused a situation the developer, Eliyahu Hershfeld, was uncomfortable with. The situation was in Canada where a user using his phone saw that this time was listed as the time for nightfall, and he figured that he could end shabbos then. Whie there are no poskim that write to do that! The earliest time that I have found to end shabbos is 20 regular minutes after sunset and that is only in Israel and the surrounding areas. Every where else was recommended 30 minutes at the bare minimum. Therefore, someone who wants to use/include this time has an obligation to make sure that it does not get used for shabbos by dimming it or showing another time.
+ * - Warning: This zman is EXTREMELY early! It is so early that it was removed from KosherJava since it caused a situation that the developer, Eliyahu Hershfeld, was uncomfortable with. The situation was in Canada where a user using his phone saw that this time was listed as the time for nightfall, and he figured that he could end shabbos then. Whie there are no poskim that write to do that! The earliest time that I have found to end shabbos is 20 regular minutes after sunset and that is only in Israel and the surrounding areas. Every where else was recommended 30 minutes at the bare minimum. Therefore, someone who wants to use/include this time has an obligation to make sure that it does not get used for shabbos by dimming it or showing another time.
* @return the Date representing the time. If the calculation can't be computed such as in the Arctic
* Circle where there is at least one day a year where the sun does not rise, and one where it does not set,
* a nil will be returned. See detailed explanation on top of the ``AstronomicalCalendar``
@@ -2947,8 +2925,8 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
}
/**
- * Method to return tzais (dusk) calculated using 90 minutes zmaniyos or 1/8th of the day after ``
- *getSeaLevelSunset() sea level sunset`` This time is known in Yiddish as the achtel (an eighth)
+ * Method to return tzais (dusk) calculated using 90 minutes zmaniyos or 1/8th of the day after
+ * ``getSeaLevelSunset()`` sea level sunset This time is known in Yiddish as the achtel (an eighth)
* zman.
*
* @return the Date representing the time. If the calculation can't be computed such as in the Arctic
@@ -2980,7 +2958,7 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
* tzais (nightfall) based on the opinion of the Magen Avraham that the time to walk the distance of a
* Mil according to the Rambam's opinion
* is 18 minutes for a total of 90 minutes based on the opinion of Ula who calculated tzais as 5
- * Mil after sea level shkiah (sunset). A similar calculation ``getTzais19Point8Degrees()
+ * Mil after sea level shkiah (sunset). A similar calculation ``getTzais19Point8Degrees()``
* uses solar position calculations based on this time.
*
* @return the Date representing the time. If the calculation can't be computed such as in the Arctic
@@ -2999,8 +2977,8 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
* of Rav Chaim Naeh that the time to walk the
* distance of a Mil according to the Rambam's opinion
* is 2/5 of an hour (24 minutes) for a total of 120 minutes based on the opinion of Ula who calculated
- * tzais as 5 Mil after sea level shkiah (sunset). A similar calculation ``
- *getTzais26Degrees() uses degree-based calculations based on this 120 minute calculation. Since the zman
+ * tzais as 5 Mil after sea level shkiah (sunset). A similar calculation
+ * ``getTzais26Degrees()`` uses degree-based calculations based on this 120 minute calculation. Since the zman
* is extremely late and at a point that is long past the 18° point where the darkest point is
* reached, it should only be used lechumra, such as delaying the start of nighttime mitzvos.
*
@@ -3091,7 +3069,7 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
}
/**
- * For information on how this is calculated see the comments on ``getAlos18Degrees()
+ * For information on how this is calculated see the comments on ``getAlos18Degrees()``
*
* @return the Date representing the time. If the calculation can't be computed such as northern and
* southern locations even south of the Arctic Circle and north of the Antarctic Circle where the sun may
@@ -3104,7 +3082,7 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
}
/**
- * For information on how this is calculated see the comments on ``getAlos19Point8Degrees
+ * For information on how this is calculated see the comments on ``getAlos19Point8Degrees()``
*
* @return the Date representing the time. If the calculation can't be computed such as northern and
* southern locations even south of the Arctic Circle and north of the Antarctic Circle where the sun may
@@ -3384,7 +3362,7 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
/**
* Returns the point in time of Molad as a Date Object. For the traditional day of week, hour,
- * minute and chalakim, ``JewishCalendar#getMoladAsDate`` and the not yet completed
+ * minute and chalakim, ``JewishCalendar.getMoladAsDate()`` and the not yet completed
* ``HebrewDateFormatter`` that will have formatting for this.
*
* @return the Date representing the moment of the molad. If the molad does not occur on this day, a
@@ -3457,7 +3435,7 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
/**
* Returns the earliest time of Kiddush Levana according to the opinions that it should not be said until 7
* days after the molad. If the time of tchilas zman Kiddush Levana occurs during the day (between
- * `` ZmanimCalendar#getAlos72()`` alos and `` ZmanimCalendar#getTzais72()`` tzais) it
+ * `` ZmanimCalendar.getAlos72()`` alos and `` ZmanimCalendar.getTzais72()`` tzais) it
* return the next tzais.
*
* @param alos
@@ -3508,8 +3486,8 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
/**
* This method returns the latest time one is allowed eating chametz on Erev Pesach according to
- * the opinion of theGRA. This time is identical to the ``
- *getSofZmanTfilaGRA() Sof zman tfilah GRA} and is provided as a convenience method for those who are
+ * the opinion of theGRA. This time is identical to the
+ * ``getSofZmanTfilaGRA()`` Sof zman tfilah GRA and is provided as a convenience method for those who are
* unaware how this zman is calculated. This time is 4 hours into the day based on the opinion of the
* GRA that the day is calculated from sunrise to sunset.
* This returns the time 4 x ``getShaahZmanisGra()`` after ``getSeaLevelSunrise()`` If it
@@ -3590,7 +3568,6 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
* of the GRA. This time is 5 hours into the day based on the
* opinion of the GRA that the day is calculated from
* sunrise to sunset. This returns the time 5 x ``getShaahZmanisGra()`` after ``getSeaLevelSunrise()`` If it is not erev Pesach, a nil will be returned.
- * @see ZmanimCalendar#getShaahZmanisGra()
* @return the Date of the latest time for burning chametz on Erev Pesach. If it is not
* erev Pesach or the calculation can't be computed such as in the Arctic Circle where there is at least
* one day a year where the sun does not rise, and one where it does not set, a nil will be
@@ -3762,10 +3739,10 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
* based on the Baal Hatanya's netz
* amiti and shkiah amiti using a dip of 1.583° below the sea level horizon. This calculation divides
* the day based on the opinion of the Baal Hatanya that the day runs from ``getSunriseBaalHatanya()`` netz amiti
- * to ``getSunsetBaalHatanya()`` shkiah amiti The calculations are based on a day from ``
- *getSunriseBaalHatanya() sea level netz amiti to ``getSunsetBaalHatanya()`` sea level shkiah amiti``
- * The day is split into 12 equal parts with each one being a shaah zmanis. This method is similar to ``
- *getTemporalHour}, but all calculations are based on a sea level sunrise and sunset.
+ * to ``getSunsetBaalHatanya()`` shkiah amiti The calculations are based on a day from
+ *``getSunriseBaalHatanya()`` sea level netz amiti to ``getSunsetBaalHatanya()`` sea level shkiah amiti
+ * The day is split into 12 equal parts with each one being a shaah zmanis. This method is similar to
+ *``getTemporalHour()``, but all calculations are based on a sea level sunrise and sunset.
* @return the long millisecond length of a shaah zmanis calculated from
* ``getSunriseBaalHatanya()`` netz amiti (sunrise)} to ``getSunsetBaalHatanya()`` shkiah amiti
* ("real" sunset) If the calculation can't be computed such as in the Arctic Circle where there is at least one day a
@@ -3786,7 +3763,6 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
* (dawn) calculated as the time when the sun is 16.9° below the eastern ``GEOMETRIC_ZENITH`` geometric horizon
* before ``getSunrise()`` For more information the source of 16.9° see ``ZENITH_16_POINT_9``
*
- * @see ZENITH_16_POINT_9
* @return The Date of dawn. If the calculation can't be computed such as northern and southern
* locations even south of the Arctic Circle and north of the Antarctic Circle where the sun may not reach
* low enough below the horizon for this calculation, a nil will be returned. See detailed
@@ -3801,10 +3777,8 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
* ``getShaahZmanisBaalHatanya()`` shaos zmaniyos (solar hours) after ``getSunriseBaalHatanya()``
* netz amiti (sunrise)} based on the opinion of the Baal Hatanya that the day is calculated from
* sunrise to sunset. This returns the time 3 x ``getShaahZmanisBaalHatanya()`` after ``getSunriseBaalHatanya()``
- * netz amiti (sunrise)``
+ * netz amiti (sunrise)
*
- * @see ZmanimCalendar#getSofZmanShma(Date, Date)
- * @see getShaahZmanisBaalHatanya()
* @return the Date of the latest zman shema according to the Baal Hatanya. If the calculation
* can't be computed such as in the Arctic Circle where there is at least one day a year where the sun does
* not rise, and one where it does not set, a nil will be returned. See detailed explanation on
@@ -3818,10 +3792,8 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
* This method returns the latest zman tfilah (time to recite the morning prayers). This time is 4
* hours into the day based on the opinion of the Baal Hatanya that the day is
* calculated from sunrise to sunset. This returns the time 4 x ``getShaahZmanisBaalHatanya()`` after
- * ``getSunriseBaalHatanya()`` netz amiti (sunrise)``
+ * ``getSunriseBaalHatanya()`` netz amiti (sunrise)
*
- * @see ZmanimCalendar#getSofZmanTfila(Date, Date)
- * @see getShaahZmanisBaalHatanya()
* @return the Date of the latest zman tfilah. If the calculation can't be computed such as in
* the Arctic Circle where there is at least one day a year where the sun does not rise, and one where it does
* not set, a nil will be returned. See detailed explanation on top of the
@@ -3838,8 +3810,6 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
* is calculated from sunrise to sunset. This returns the time 4 ``getShaahZmanisBaalHatanya()`` after
* ``getSunriseBaalHatanya()`` netz amiti (sunrise) If it is not erev Pesach, a nil will be
* returned.
- * @see getShaahZmanisBaalHatanya()
- * @see getSofZmanTfilaBaalHatanya()
* @return the Date one is allowed eating chametz on Erev Pesach. If it is not erev
* Pesach or the calculation can't be computed such as in the Arctic Circle where there is at least one
* day a year where the sun does not rise, and one where it does not set, a nil will be returned.
@@ -3859,7 +3829,6 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
* the Baal Hatanya. This time is 5 hours into the day based on the opinion of the Baal Hatanya that the day is calculated
* from sunrise to sunset. This returns the time 5 x ``getShaahZmanisBaalHatanya()`` after
* ``getSunriseBaalHatanya()`` netz amiti (sunrise). If it is not erev Pesach, a nil will be returned.
- * @see getShaahZmanisBaalHatanya()
* @return the Date of the latest time for burning chametz on Erev Pesach. If it is not
* erev Pesach or the calculation can't be computed such as in the Arctic Circle where there is at
* least one day a year where the sun does not rise, and one where it does not set, a nil will be
@@ -3881,16 +3850,10 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
* Ra"sh,
* Tur, GRA and others are of the opinion that mincha can be prayed
- * lechatchila starting at mincha gedola. This is calculated as 6.5 ``getShaahZmanisBaalHatanya()
- * sea level solar hours} after ``getSunriseBaalHatanya()`` netz amiti (sunrise) This calculation is based
+ * lechatchila starting at mincha gedola. This is calculated as 6.5``getShaahZmanisBaalHatanya()``
+ * sea level solar hours after ``getSunriseBaalHatanya()`` netz amiti (sunrise) This calculation is based
* on the opinion of the Baal Hatanya that the day is calculated from sunrise to sunset. This returns the time 6.5
- * * ``getShaahZmanisBaalHatanya()`` after ``getSunriseBaalHatanya()`` netz amiti ("real" sunrise)
- * @todo Consider adjusting this to calculate the time as 30 clock or zmaniyos minutes after either ``
- * getSunTransit() astronomical chatzos or ``getChatzosAsHalfDay()`` chatzos as half a day}
- * for `` AstronomicalCalculator`` calculators that support it, based on ``isUseAstronomicalChatzos()``
- * @see getMinchaGedola(Date, Date)
- * @see getShaahZmanisBaalHatanya()
- * @see getMinchaKetanaBaalHatanya()
+ * ``getShaahZmanisBaalHatanya()`` after ``getSunriseBaalHatanya()`` netz amiti ("real" sunrise)
* @return the Date of the time of mincha gedola according to the Baal Hatanya. If the calculation
* can't be computed such as in the Arctic Circle where there is at least one day a year where the sun does not rise,
* and one where it does not set, a nil will be returned. See detailed explanation on top of the
@@ -3906,9 +3869,6 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
* ``getMinchaGedola30Minutes()`` In the winter when 1/2 of a ``getShaahZmanisBaalHatanya()``
* shaah zmanis is less than 30 minutes ``getMinchaGedola30Minutes()`` will be returned, otherwise
* ``getMinchaGedolaBaalHatanya()`` will be returned.
- * @todo Consider adjusting this to calculate the time as 30 clock or zmaniyos minutes after either
- * getSunTransit() astronomical chatzos or ``getChatzosAsHalfDay()`` chatzos as half a day
- * for ``AstronomicalCalculator`` calculators that support it, based on ``isUseAstronomicalChatzos()``
* @return the Date of the later of ``getMinchaGedolaBaalHatanya()`` and ``getMinchaGedola30Minutes()``
* If the calculation can't be computed such as in the Arctic Circle where there is at least one day a year
* where the sun does not rise, and one where it does not set, a nil will be returned. See detailed
@@ -3929,15 +3889,12 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
/**
* This method returns the time of mincha ketana. This is the preferred earliest time to pray
* mincha in the opinion of the Rambam and others.
- * For more information on this see the documentation on ``getMinchaGedolaBaalHatanya()`` mincha gedola``
- * This is calculated as 9.5 ``getShaahZmanisBaalHatanya()`` sea level solar hours} after ``getSunriseBaalHatanya()``
+ * For more information on this see the documentation on ``getMinchaGedolaBaalHatanya()`` mincha gedola
+ * This is calculated as 9.5 ``getShaahZmanisBaalHatanya()`` sea level solar hours} after ``getSunriseBaalHatanya()``
* netz amiti (sunrise) This calculation is calculated based on the opinion of the Baal Hatanya that the
- * day is calculated from sunrise to sunset. This returns the time 9.5 x ``getShaahZmanisBaalHatanya()`` after
- *``getSunriseBaalHatanya()`` netz amiti (sunrise)
+ * day is calculated from sunrise to sunset. This returns the time 9.5 x ``getShaahZmanisBaalHatanya()`` after
+ * ``getSunriseBaalHatanya()`` netz amiti (sunrise)
*
- * @see getMinchaKetana(Date, Date)
- * @see getShaahZmanisBaalHatanya()
- * @see getMinchaGedolaBaalHatanya()
* @return the Date of the time of mincha ketana. If the calculation can't be computed such as
* in the Arctic Circle where there is at least one day a year where the sun does not rise, and one where it
* does not set, a nil will be returned. See detailed explanation on top of the
@@ -3951,9 +3908,8 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
* This method returns the time of plag hamincha. This is calculated as 10.75 hours after sunrise. This
* calculation is based on the opinion of the Baal Hatanya that the day is calculated
* from sunrise to sunset. This returns the time 10.75 x ``getShaahZmanisBaalHatanya()`` after
- * ``getSunriseBaalHatanya()`` netz amiti (sunrise)``
+ * ``getSunriseBaalHatanya()`` netz amiti (sunrise)
*
- * @see getPlagHamincha(Date, Date)
* @return the Date of the time of plag hamincha. If the calculation can't be computed such as
* in the Arctic Circle where there is at least one day a year where the sun does not rise, and one where it
* does not set, a nil will be returned. See detailed explanation on top of the
@@ -4185,9 +4141,6 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
* 16.1° See the Mechaber and Mishna Berurah
* 232 for details.
*
- * @see getShaahZmanisGra()
- * @see getSamuchLeMinchaKetana16Point1Degrees()
- * @see isUseAstronomicalChatzosForOtherZmanim()
* @return the Date of the time of samuch lemincha ketana. If the calculation can't be computed such
* as northern and southern locations even south of the Arctic Circle and north of the Antarctic Circle
* where the sun may not reach low enough below the horizon for this calculation, a nil will be
@@ -4205,7 +4158,6 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
* ``getShaahZmanis16Point1Degrees()`` after ``getAlos16Point1Degrees()`` alos 16.1° See the Mechaber and Mishna Berurah 232.
*
- * @see getShaahZmanis16Point1Degrees()
* @return the Date of the time of samuch lemincha ketana. If the calculation can't be computed such
* as northern and southern locations even south of the Arctic Circle and north of the Antarctic Circle
* where the sun may not reach low enough below the horizon for this calculation, a nil will be returned.
@@ -4223,7 +4175,6 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
* ``getShaahZmanis16Point1Degrees()`` after ``getAlos16Point1Degrees()`` alos 16.1° See the Mechaber and Mishna Berurah 232.
*
- * @see getShaahZmanis16Point1Degrees()
* @return the Date of the time of samuch lemincha ketana. If the calculation can't be computed such
* as northern and southern locations even south of the Arctic Circle and north of the Antarctic Circle
* where the sun may not reach low enough below the horizon for this calculation, a nil will be returned.
@@ -4266,6 +4217,7 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
* Yalkut Yosef holds that the time for Plag Hamincha is calculated by taking 1.25 "seasonal hours" (Sha'ot Zmaniot) from tzait hacochavim.
* This is how Rabbi Dahan calculates Plag Hamincha in his Amudei Horaah calendar with his own algorithm for tzait hacochavim.
* Note: The Amudei Horaah calendar provides both the Yalkut Yosef and Halacha Berurah times for Plag Hamincha. (No elevation adjustment is used)
+ * - Warning: This zman should NOT be used in Israel.
* @return the time for Plag Hamincha as calculated by the Amudei Horaah calendar and Yalkut Yosef.
*/
public func getPlagHaminchaYalkutYosefAmudeiHoraah() -> Date? {
@@ -4309,7 +4261,7 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
/**
* This method returns the time of misheyakir calculated by the Amudei Horaah calendar.
* Rabbi Dahan calculates this zman for as 5/6 of the time between alot and sunrise in the Amudei Horaah calendar.
- * Warning: This zman should NOT be used in Israel.
+ * - Warning: This zman should NOT be used in Israel.
* @return the time of misheyakir calculated by the Amudei Horaah calendar by adjusting the zman based off of degrees.
*/
public func getMisheyakirAmudeiHoraah() -> Date? {
@@ -4343,11 +4295,9 @@ public class ComplexZmanimCalendar : ZmanimCalendar {
}
/**
- * This method calculates the time for Nightfall according to the opinion of the Amudei Horaah Calendar. This is calculated as 13.5
- * adjusted zmaniyot minutes after sunset. This is based on the calculation of the 3.77° which is the time at 13.5 minutes in Netanya, Israel
- * on the equinox. Why Netanya and not Jerusalem? Because Netanya is the mid point between Israel and Iraq. Therefore, Rabbi Dahan equates them.
- * @return the Date representing 13.5 minutes zmaniyot after sunset adjusted to the users location using degrees based on Netanya, Israel. This zman
- * should NOT be used in Israel.
+ * This method calculates the time for Nightfall according to the opinion of the Amudei Horaah Calendar. This is calculated as 13.5 adjusted zmaniyot minutes after sunset. This is based on the calculation of the 3.77° which is the time at 13.5 minutes in Netanya, Israel on the equinox. Why Netanya and not Jerusalem? Because Netanya is the mid point between Israel and Iraq. Therefore, Rabbi Dahan equates them.
+ - Warning: This zman should NOT be used in Israel.
+ @return the Date representing 13.5 minutes zmaniyot after sunset adjusted to the users location using degrees based on Netanya, Israel.
*/
public func getTzaisAmudeiHoraah() -> Date? {
var calendar = Calendar.current
diff --git a/Sources/KosherSwift/ZmanimCalendar.swift b/Sources/KosherSwift/ZmanimCalendar.swift
index aa72e32..f7ddf88 100644
--- a/Sources/KosherSwift/ZmanimCalendar.swift
+++ b/Sources/KosherSwift/ZmanimCalendar.swift
@@ -56,7 +56,7 @@ import Foundation
public class ZmanimCalendar : AstronomicalCalendar {
/**
- * Is elevation factored in for some zmanim (see ``isUseElevation()`` for additional information).
+ * Is elevation factored in for some zmanim (see ``setUseElevation(useElevation:)`` for additional information).
* @see #isUseElevation()
* @see #setUseElevation(boolean)
*/
@@ -72,7 +72,7 @@ public class ZmanimCalendar : AstronomicalCalendar {
* accounted for in zmanim calculations. Related to this, Rabbi Yaakov Karp in Shimush Zekeinim, Ch. 1, page 17 states that obstructing horizons
* should be factored into zmanim calculations. The setting defaults to false (elevation will not be used for
- * zmanim calculations), unless the setting is changed to true in ``setUseElevation()``. This will
+ * zmanim calculations), unless the setting is changed to true in ``setUseElevation(useElevation:)``. This will
* impact sunrise and sunset based zmanim such as ``getSunrise()``, ``getSunset()``,
* ``getSofZmanShmaGRA()``, alos based zmanim such as ``getSofZmanShmaMGA()`` that are based on a
* fixed offset of sunrise or sunset and zmanim based on a percentage of the day such as {@link
@@ -90,7 +90,7 @@ public class ZmanimCalendar : AstronomicalCalendar {
/**
* Sets whether elevation above sea level is factored into zmanim calculations for times besides sunrise and sunset.
- * See ``isUseElevation()`` for more details.
+ * See ``setUseElevation(useElevation:)`` for more details.
* @see #isUseElevation()
*
* @param useElevation set to true to use elevation in zmanim calculations
@@ -242,11 +242,11 @@ public class ZmanimCalendar : AstronomicalCalendar {
public var candleLightingOffset = 18;
/**
- * This method will return ``getSeaLevelSunrise()`` if ``isUseElevation()`` is false (the
+ * This method will return ``getSeaLevelSunrise()`` if ``setUseElevation(useElevation:)`` is false (the
* default), or elevation adjusted {@link AstronomicalCalendar#getSunrise()} if it is true. This allows relevant zmanim
* in this and extending classes (such as the``ComplexZmanimCalendar``) to automatically adjust to the elevation setting.
*
- * @return {@link #getSeaLevelSunrise()} if ``isUseElevation()`` is false (the default), or elevation adjusted
+ * @return {@link #getSeaLevelSunrise()} if ``setUseElevation(useElevation:)`` is false (the default), or elevation adjusted
* {@link AstronomicalCalendar#getSunrise()} if it is true.
* @see com.kosherjava.zmanim.AstronomicalCalendar#getSunrise()
*/
@@ -258,11 +258,11 @@ public class ZmanimCalendar : AstronomicalCalendar {
}
/**
- * This method will return ``getSeaLevelSunrise()`` if ``isUseElevation()`` is false (the default),
+ * This method will return ``getSeaLevelSunrise()`` if ``setUseElevation(useElevation:)`` is false (the default),
* or elevation adjusted {@link AstronomicalCalendar#getSunrise()} if it is true. This allows relevant zmanim
* in this and extending classes (such as the``ComplexZmanimCalendar``) to automatically adjust to the elevation setting.
*
- * @return {@link #getSeaLevelSunset()} if ``isUseElevation()`` is false (the default), or elevation adjusted
+ * @return {@link #getSeaLevelSunset()} if ``setUseElevation(useElevation:)`` is false (the default), or elevation adjusted
* {@link AstronomicalCalendar#getSunset()} if it is true.
* @see com.kosherjava.zmanim.AstronomicalCalendar#getSunset()
*/
@@ -315,7 +315,7 @@ public class ZmanimCalendar : AstronomicalCalendar {
/**
* Method to return alos (dawn) calculated using 72 minutes before ``getSunrise()`` or
- * ``getSeaLevelSunrise()`` (depending on the ``isUseElevation()`` setting). This time
+ * ``getSeaLevelSunrise()`` (depending on the ``setUseElevation(useElevation:)`` setting). This time
* is based on the time to walk the distance of 4 Mil at 18 minutes a Mil. The 72 minute time (but
* not the concept of fixed minutes) is based on the opinion that the time of the Neshef (twilight between
* dawn and sunrise) does not vary by the time of year or location but depends on the time it takes to walk the
@@ -409,7 +409,7 @@ public class ZmanimCalendar : AstronomicalCalendar {
* based on 1/6 of the time between sunrise and {@link #getSunTransit() astronomical chatzos}. As an example, passing
* ``getSunrise()`` and ``getSunset()`` or ``getSeaLevelSunrise()`` and {@link
* #getSeaLevelSunset() sea level sunset} to this method (or {@link #getElevationAdjustedSunrise()} and {@link
- * #getElevationAdjustedSunset()} that is driven off the ``isUseElevation()`` setting) will return sof zman krias
+ * #getElevationAdjustedSunset()} that is driven off the ``setUseElevation(useElevation:)`` setting) will return sof zman krias
* shema according to the opinion of the GRA. In cases
* where the start and end dates are not synchronous such as in {@link ComplexZmanimCalendar
* #getSofZmanShmaAlos16Point1ToTzaisGeonim7Point083Degrees()} false should be passed to the synchronous parameter
@@ -462,10 +462,10 @@ public class ZmanimCalendar : AstronomicalCalendar {
/**
* This method returns the latest zman krias shema (time to recite shema in the morning) that is 3 *
* {@link #getShaahZmanisGra() shaos zmaniyos} (solar hours) after ``getSunrise()`` or
- * ``getSeaLevelSunrise()`` (depending on the ``isUseElevation()`` setting), according
+ * ``getSeaLevelSunrise()`` (depending on the ``setUseElevation(useElevation:)`` setting), according
* to the GRA.
* The day is calculated from ``getSeaLevelSunrise()`` to {@link #getSeaLevelSunrise sea level
- * sunset} or ``getSunrise()`` to ``getSunset()`` (depending on the ``isUseElevation()``
+ * sunset} or ``getSunrise()`` to ``getSunset()`` (depending on the ``setUseElevation(useElevation:)``
* setting).
*
* @see #getSofZmanShma(Date, Date)
@@ -487,7 +487,7 @@ public class ZmanimCalendar : AstronomicalCalendar {
* Magen Avraham (MGA). The day is calculated
* from 72 minutes before ``getSeaLevelSunrise()`` to 72 minutes after {@link
* #getSeaLevelSunrise sea level sunset} or from 72 minutes before ``getSunrise()`` to {@link #getSunset()
- * sunset} (depending on the ``isUseElevation()`` setting).
+ * sunset} (depending on the ``setUseElevation(useElevation:)`` setting).
*
* @return the Date of the latest zman shema. If the calculation can't be computed such as in
* the Arctic Circle where there is at least one day a year where the sun does not rise, and one where it
@@ -508,7 +508,7 @@ public class ZmanimCalendar : AstronomicalCalendar {
* a Mil. According to the Machtzis Hashekel in
* Orach Chaim 235:3, the Pri Megadim in Orach
* Chaim 261:2 (see the Biur Halacha) and others (see Hazmanim Bahalacha 17:3 and 17:5) the 72 minutes are standard
- * clock minutes any time of the year in any location. Depending on the ``isUseElevation()`` setting) a 72
+ * clock minutes any time of the year in any location. Depending on the ``setUseElevation(useElevation:)`` setting) a 72
* minute offset from either ``getSunset()`` or ``getSeaLevelSunset()`` is used.
*
* @see ComplexZmanimCalendar#getTzais16Point1Degrees()
@@ -547,7 +547,7 @@ public class ZmanimCalendar : AstronomicalCalendar {
* The time from the start of day to the end of day are divided into 12 shaos zmaniyos (temporal hours),
* and sof zman tfila is calculated as 4 of those shaos zmaniyos after the beginning of the day.
* As an example, passing ``getSunrise()`` and ``getSunset()`` or {@link #getSeaLevelSunrise()
- * sea level sunrise} and ``getSeaLevelSunset()`` (depending on the ``isUseElevation()``
+ * sea level sunrise} and ``getSeaLevelSunset()`` (depending on the ``setUseElevation(useElevation:)``
* elevation setting) to this method will return zman tfilah according to the opinion of the GRA. This method's synchronous parameter indicates if the start
* and end of day for the calculation are synchronous, having the same offset. This is typically the case, but some
@@ -603,10 +603,10 @@ public class ZmanimCalendar : AstronomicalCalendar {
/**
* This method returns the latest zman tfila (time to recite shema in the morning) that is 4 *
* {@link #getShaahZmanisGra() shaos zmaniyos }(solar hours) after ``getSunrise()`` or
- * ``getSeaLevelSunrise()`` (depending on the ``isUseElevation()`` setting), according
+ * ``getSeaLevelSunrise()`` (depending on the ``setUseElevation(useElevation:)`` setting), according
* to the GRA.
* The day is calculated from ``getSeaLevelSunrise()`` to {@link #getSeaLevelSunrise sea level
- * sunset} or ``getSunrise()`` to ``getSunset()`` (depending on the ``isUseElevation()``
+ * sunset} or ``getSunrise()`` to ``getSunset()`` (depending on the ``setUseElevation(useElevation:)``
* setting).
*
* @see #getSofZmanTfila(Date, Date)
@@ -627,7 +627,7 @@ public class ZmanimCalendar : AstronomicalCalendar {
* Magen Avraham (MGA). The day is calculated
* from 72 minutes before ``getSeaLevelSunrise()`` to 72 minutes after {@link
* #getSeaLevelSunrise sea level sunset} or from 72 minutes before ``getSunrise()`` to {@link #getSunset()
- * sunset} (depending on the ``isUseElevation()`` setting).
+ * sunset} (depending on the ``setUseElevation(useElevation:)`` setting).
*
* @return the Date of the latest zman tfila. If the calculation can't be computed such as in
* the Arctic Circle where there is at least one day a year where the sun does not rise, and one where it
@@ -713,13 +713,13 @@ public class ZmanimCalendar : AstronomicalCalendar {
/**
* This method returns the latest mincha gedola,the earliest time one can pray mincha that is 6.5 *
* {@link #getShaahZmanisGra() shaos zmaniyos} (solar hours) after ``getSunrise()`` or
- * ``getSeaLevelSunrise()`` (depending on the ``isUseElevation()`` setting), according
+ * ``getSeaLevelSunrise()`` (depending on the ``setUseElevation(useElevation:)`` setting), according
* to the GRA. Mincha gedola is the earliest
* time one can pray mincha. The Ramba"m is of the opinion that it is better to delay mincha until
* {@link #getMinchaKetana() mincha ketana} while the Ra"sh, Tur, GRA and others are of the
* opinion that mincha can be prayed lechatchila starting at mincha gedola.
* The day is calculated from ``getSeaLevelSunrise()`` to {@link #getSeaLevelSunrise sea level
- * sunset} or ``getSunrise()`` to ``getSunset()`` (depending on the ``isUseElevation()``
+ * sunset} or ``getSunrise()`` to ``getSunset()`` (depending on the ``setUseElevation(useElevation:)``
* setting).
* @todo Consider adjusting this to calculate the time as half an hour zmaniyos after either {@link
* #getSunTransit() astronomical chatzos} or {@link #getChatzosAsHalfDay() chatzos as half a day}
@@ -744,7 +744,7 @@ public class ZmanimCalendar : AstronomicalCalendar {
* start of the day, calculated using the start and end of the day passed to this method.
* The time from the start of day to the end of day are divided into 12 shaos zmaniyos (temporal hours), and
* samuch lemincha ketana is calculated as 9 of those shaos zmaniyos after the beginning of the day.
- * For example, passing ``getSunrise()`` and ``getSunset()`` or ``getSeaLevelSunrise()`` and ``getSeaLevelSunset()`` (depending on the ``isUseElevation()`` elevation
+ * For example, passing ``getSunrise()`` and ``getSunset()`` or ``getSeaLevelSunrise()`` and ``getSeaLevelSunset()`` (depending on the ``setUseElevation(useElevation:)`` elevation
* setting) to this method will return samuch lemincha ketana according to the opinion of the
* GRA.
*
@@ -803,7 +803,7 @@ public class ZmanimCalendar : AstronomicalCalendar {
* The time from the start of day to the end of day are divided into 12 shaos zmaniyos (temporal hours), and
* mincha ketana is calculated as 9.5 of those shaos zmaniyos after the beginning of the day. As an
* example, passing ``getSunrise()`` and ``getSunset()`` or {@link #getSeaLevelSunrise() sea
- * level sunrise} and ``getSeaLevelSunset()`` (depending on the ``isUseElevation()``
+ * level sunrise} and ``getSeaLevelSunset()`` (depending on the ``setUseElevation(useElevation:)``
* elevation setting) to this method will return mincha ketana according to the opinion of the
* GRA. This method's synchronous parameter indicates ifthe start
* and end of day for the calculation are synchronous, having the same offset. This is typically the case, but some
@@ -860,10 +860,10 @@ public class ZmanimCalendar : AstronomicalCalendar {
* This method returns mincha ketana,the preferred earliest time to pray mincha in the
* opinion of the Rambam and others, that is 9.5
* * {@link #getShaahZmanisGra() shaos zmaniyos} (solar hours) after ``getSunrise()`` or
- * ``getSeaLevelSunrise()`` (depending on the ``isUseElevation()`` setting), according
+ * ``getSeaLevelSunrise()`` (depending on the ``setUseElevation(useElevation:)`` setting), according
* to the GRA. For more information on this see the
* documentation on ``getMinchaGedola()``.
- * The day is calculated from ``getSeaLevelSunrise()`` to ``getSeaLevelSunset()`` or ``getSunrise()`` to ``getSunset()`` (depending on the ``isUseElevation()``
+ * The day is calculated from ``getSeaLevelSunrise()`` to ``getSeaLevelSunset()`` or ``getSunrise()`` to ``getSunset()`` (depending on the ``setUseElevation(useElevation:)``
* setting.
*
* @see #getMinchaKetana(Date, Date)
@@ -886,7 +886,7 @@ public class ZmanimCalendar : AstronomicalCalendar {
* The time from the start of day to the end of day are divided into 12 shaos zmaniyos (temporal hours), and
* plag hamincha is calculated as 10.75 of those shaos zmaniyos after the beginning of the day. As an
* example, passing ``getSunrise()`` and ``getSunset()`` or {@link #getSeaLevelSunrise() sea level
- * sunrise} and ``getSeaLevelSunset()`` (depending on the ``isUseElevation()`` elevation
+ * sunrise} and ``getSeaLevelSunset()`` (depending on the ``setUseElevation(useElevation:)`` elevation
* setting) to this method will return plag mincha according to the opinion of the
* GRA. This method's synchronous parameter indicates if
* the start and end of day for the calculation are synchronous, having the same offset. This is typically the case, but
@@ -938,10 +938,10 @@ public class ZmanimCalendar : AstronomicalCalendar {
/**
* This method returns plag hamincha, that is 10.75 * {@link #getShaahZmanisGra() shaos zmaniyos}
* (solar hours) after ``getSunrise()`` or ``getSeaLevelSunrise()`` (depending on
- * the ``isUseElevation()`` setting), according to the GRA. Plag hamincha is the earliest time that Shabbos can be started.
* The day is calculated from ``getSeaLevelSunrise()`` to {@link #getSeaLevelSunrise sea level
- * sunset} or ``getSunrise()`` to ``getSunset()`` (depending on the ``isUseElevation()``
+ * sunset} or ``getSunrise()`` to ``getSunset()`` (depending on the ``setUseElevation(useElevation:)``
*
* @see #getPlagHamincha(Date, Date, boolean)
* @see #getPlagHamincha(Date, Date)
@@ -960,7 +960,7 @@ public class ZmanimCalendar : AstronomicalCalendar {
* the opinion of the GRA. This calculation divides
* the day based on the opinion of the GRA that the day runs from from {@link #getSeaLevelSunrise() sea
* level sunrise} to {@link #getSeaLevelSunrise sea level sunset} or ``getSunrise()`` to
- * ``getSunset()`` (depending on the ``isUseElevation()`` setting). The day is split into 12 equal
+ * ``getSunset()`` (depending on the ``setUseElevation(useElevation:)`` setting). The day is split into 12 equal
* parts with each one being a shaah zmanis. This method is similar to {@link #getTemporalHour}, but can
* account for elevation.
*
@@ -982,8 +982,8 @@ public class ZmanimCalendar : AstronomicalCalendar {
* "https://en.wikipedia.org/wiki/Avraham_Gombinern">Magen Avraham (MGA) based on a 72 minutes alos
* and tzais. This calculation divides the day that runs from dawn to dusk (for sof zman krias shema and
* tfila). Dawn for this calculation is 72 minutes before ``getSunrise()`` or {@link #getSeaLevelSunrise()
- * sea level sunrise} (depending on the ``isUseElevation()`` elevation setting) and dusk is 72 minutes after {@link
- * #getSunset sunset} or ``getSeaLevelSunset()`` (depending on the ``isUseElevation()`` elevation
+ * sea level sunrise} (depending on the ``setUseElevation(useElevation:)`` elevation setting) and dusk is 72 minutes after {@link
+ * #getSunset sunset} or ``getSeaLevelSunset()`` (depending on the ``setUseElevation(useElevation:)`` elevation
* setting). This day is split into 12 equal parts with each part being a shaah zmanis. Alternate methods of calculating
* a shaah zmanis according to the Magen Avraham (MGA) are available in the subclass``ComplexZmanimCalendar``.
*
@@ -1050,7 +1050,7 @@ public class ZmanimCalendar : AstronomicalCalendar {
* This is a utility method to determine if the current Date (date-time) passed in has a melacha (work) prohibition.
* Since there are many opinions on the time of tzais, the tzais for the current day has to be passed to this
* class. Sunset is the classes current day's ``getElevationAdjustedSunset`` that observes the
- * ``isUseElevation()`` settings. The ``JewishCalendar#getInIsrael()`` will be set by the inIsrael parameter.
+ * ``setUseElevation(useElevation:)`` settings. The ``JewishCalendar#getInIsrael()`` will be set by the inIsrael parameter.
*
* @param currentTime the current time
* @param tzais the time of tzais
@@ -1084,7 +1084,7 @@ public class ZmanimCalendar : AstronomicalCalendar {
* method. This simplifies the code in other methods such as ``getPlagHamincha(startOfDay:endOfDay:)`` and cuts down on
* code replication. As an example, passing ``getSunrise()`` and ``getSunset()`` or
* ``#getSeaLevelSunrise()`` and ``getSeaLevelSunset()`` (depending on the
- * ``isUseElevation()`` elevation setting) and 10.75 hours to this method will return plag mincha
+ * ``setUseElevation(useElevation:)`` elevation setting) and 10.75 hours to this method will return plag mincha
* according to the opinion of the GRA.
*
* @param startOfDay