Skip to content

Commit 926bfb5

Browse files
authored
JavaDoc cleanup in ZmanimCalendar
1 parent 1694d2c commit 926bfb5

1 file changed

Lines changed: 10 additions & 29 deletions

File tree

src/main/java/com/kosherjava/zmanim/ZmanimCalendar.java

Lines changed: 10 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -216,15 +216,7 @@ public void setUseAstronomicalChatzosForOtherZmanim(boolean useAstronomicalChatz
216216
}
217217

218218
/**
219-
* The zenith of 16.1&deg; below geometric zenith (90&deg;). This calculation is used for determining <em>alos</em>
220-
* (dawn) and <em>tzais</em> (nightfall) in some opinions. It is based on the calculation that the time between dawn
221-
* and sunrise (and sunset to nightfall) is 72 minutes, the time that is takes to walk 4 <a href=
222-
* "https://en.wikipedia.org/wiki/Biblical_and_Talmudic_units_of_measurement">mil</a> at 18 minutes a mil (<a href=
223-
* "https://en.wikipedia.org/wiki/Maimonides">Rambam</a> and others). The sun's position below the horizon 72 minutes
224-
* before {@link #getSunriseWithElevation() sunrise} in Jerusalem <a href=
225-
* "https://kosherjava.com/2022/01/12/equinox-vs-equilux-zmanim-calculations/">around the equinox / equilux</a> is
226-
* 16.1&deg; below {@link #GEOMETRIC_ZENITH geometric zenith}.
227-
*
219+
* The zenith of 16.1&deg; below geometric zenith (90&deg;).
228220
* @see #getAlos16Point1Degrees()
229221
* @see ComprehensiveZmanimCalendar#getTzais16Point1Degrees()
230222
* @see ComprehensiveZmanimCalendar#getSofZmanShmaMGA16Point1Degrees()
@@ -238,23 +230,13 @@ public void setUseAstronomicalChatzosForOtherZmanim(boolean useAstronomicalChatz
238230
protected static final double ZENITH_16_POINT_1 = GEOMETRIC_ZENITH + 16.1;
239231

240232
/**
241-
* The zenith of 8.5&deg; below geometric zenith (90&deg;). This calculation is used for calculating <em>alos</em>
242-
* (dawn) and <em>tzais</em> (nightfall) in some opinions. This calculation is based on the sun's position below the
243-
* horizon 36 minutes after {@link #getSunsetWithElevation() sunset} in Jerusalem <a href=
244-
* "https://kosherjava.com/2022/01/12/equinox-vs-equilux-zmanim-calculations/">around the equinox / equilux</a>, which
245-
* is 8.5&deg; below {@link #GEOMETRIC_ZENITH geometric zenith}. The <em><a href=
246-
* "https://www.worldcat.org/oclc/29283612">Ohr Meir</a></em> considers this the time that 3 small stars are visible,
247-
* which is later than the required 3 medium stars.
248-
*
233+
* The zenith of 8.5&deg; below geometric zenith (90&deg;).
249234
* @see #getTzaisGeonim8Point5Degrees()
250235
*/
251236
protected static final double ZENITH_8_POINT_5 = GEOMETRIC_ZENITH + 8.5;
252237

253238
/**
254-
* The zenith of 1.583&deg; below {@link #GEOMETRIC_ZENITH geometric zenith} (90&deg;). This calculation is used for
255-
* calculating <em>netz amiti</em> (sunrise) and <em>shkiah amiti</em> (sunset) based on the opinion of the
256-
* <a href="https://en.wikipedia.org/wiki/Shneur_Zalman_of_Liadi">Baal Hatanya</a>.
257-
*
239+
* The zenith of 1.583&deg; below {@link #GEOMETRIC_ZENITH geometric zenith} (90&deg;).
258240
* @see #getSunriseBaalHatanya()
259241
* @see #getSunsetBaalHatanya()
260242
*/
@@ -300,17 +282,17 @@ protected Instant getSunsetBasedOnElevationSetting() {
300282

301283
/**
302284
* A method that returns <em>tzais</em> (nightfall) when the sun is {@link #ZENITH_8_POINT_5 8.5&deg;} below the
303-
* {@link #GEOMETRIC_ZENITH geometric horizon} (90&deg;) after {@link #getSunsetWithElevation() sunset}, a time that Rabbi Meir
304-
* Posen in his the <em><a href="https://www.worldcat.org/oclc/29283612">Ohr Meir</a></em> calculated that 3 small
305-
* stars are visible, which is later than the required 3 medium stars. See the {@link #ZENITH_8_POINT_5} constant.
306-
*
307-
* @see #ZENITH_8_POINT_5
285+
* {@link #GEOMETRIC_ZENITH geometric horizon} (90&deg;) after {@link #getSunsetWithElevation() sunset}, a time that Rabbi
286+
* Meir Posen in his the <em><a href="https://www.worldcat.org/oclc/29283612">Ohr Meir</a></em> calculated that 3 small
287+
* stars are visible, which is later than the required 3 medium stars. This calculation is based on the sun's position below
288+
* the horizon 36 minutes after {@link #getSeaLevelSunrise() sunset} in Jerusalem <a href=
289+
* "https://kosherjava.com/2022/01/12/equinox-vs-equilux-zmanim-calculations/">around the equinox / equilux</a>, which
290+
* is 8.5&deg; below {@link #GEOMETRIC_ZENITH geometric zenith}.
308291
*
309292
* @return The <code>Instant</code> of nightfall. If the calculation can't be computed such as northern and southern
310293
* locations even south of the Arctic Circle and north of the Antarctic Circle where the sun may not reach
311294
* low enough below the horizon for this calculation, a <code>null</code> will be returned. See detailed
312295
* explanation on top of the {@link AstronomicalCalendar} documentation.
313-
* @see #ZENITH_8_POINT_5
314296
* ComprehensiveZmanimCalendar#getTzaisGeonim8Point5Degrees() that returns an identical time to this generic <em>tzais</em>
315297
*/
316298
public Instant getTzaisGeonim8Point5Degrees() {
@@ -327,8 +309,7 @@ public Instant getTzaisGeonim8Point5Degrees() {
327309
* "https://kosherjava.com/2022/01/12/equinox-vs-equilux-zmanim-calculations/">around the equinox / equilux</a> is
328310
* 16.1&deg; below {@link #GEOMETRIC_ZENITH}.
329311
*
330-
* @see #ZENITH_16_POINT_1
331-
* @see ComprehensiveZmanimCalendar#getAlos16Point1Degrees()
312+
* @see ComprehensiveZmanimCalendar#getTzais16Point1Degrees()
332313
*
333314
* @return The <code>Instant</code> of dawn. If the calculation can't be computed such as northern and southern
334315
* locations even south of the Arctic Circle and north of the Antarctic Circle where the sun may not reach

0 commit comments

Comments
 (0)