Skip to content

Commit 9ddfe4d

Browse files
authored
Update the hebrewcaendar package-info
1 parent 622857c commit 9ddfe4d

1 file changed

Lines changed: 17 additions & 5 deletions

File tree

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,31 @@
11
/**
2-
* This package contain classes that represent a <a href="https://en.wikipedia.org/wiki/Hebrew_calendar">Jewish Date/Calendar</a>,
2+
* This package contains classes that represent a <a href="https://en.wikipedia.org/wiki/Hebrew_calendar">Jewish Date/Calendar</a>,
33
* and allows conversion between {@link JewishDate Jewish} and {@link java.time.LocalDate Gregorian dates}. The main calendar
44
* classes {@link JewishCalendar} and {@link JewishDate} are based on <a href="https://www.linkedin.com/in/avromf/">Avrom Finkelstein's</a> code from 2002,
55
* refactored to fit the Zmanim API. The parsha and season-based <em>tefila</em> change code was ported by Y. Paritcher from his
66
* <a href="https://github.com/yparitcher/libzmanim">libzmanim</a> code.
7-
*
7+
*
88
* <h2>Design:</h2>
99
* <ul>
1010
* <li>{@link JewishDate} is the base class, allowing the maintenance of an instance of a Gregorian date along with the corresponding Jewish date.</li>
11-
* <li>{@link JewishCalendar} extends JewishDate and adds some methods related to the calendar.</li>
11+
* <li>{@link JewishCalendar} extends JewishDate and adds calendar information: <em>Yamim Tovim</em>, fast days, <em>Rosh Chodesh</em>,
12+
* <em>Chanukah</em>, the weekly <em>parsha</em> and special <em>parshiyos</em>, the <em>molad</em>, <em>tekufos</em>,
13+
* <em>Birkas Hachamah</em> and <em>Daf Yomi</em>.</li>
1214
* <li>{@link TefilaRules} is a utility class for various calendar based <em>tefila</em> rules.</li>
13-
* <li>{@link HebrewDateFormatter} defines the basics for taking a JewishCalendar and formatting the dates.</li>
15+
* <li>{@link HebrewDateFormatter} formats dates, <em>Yamim Tovim</em>, <em>parshiyos</em> and numbers, in Hebrew or transliterated,
16+
* with options such as final-form letters and <em>geresh</em> / <em>gershayim</em>.</li>
1417
* <li>{@link YomiCalculator} calculates the {@link Daf} Yomi Bavli for a given JewishCalendar and {@link YerushalmiYomiCalculator} does the same
1518
* for Yerushalmi Yomi.</li>
1619
* </ul>
17-
* @author © Eliyahu Hershfeld 2011 - 2026
20+
*
21+
* <h2>Settings that change results:</h2>
22+
* <ul>
23+
* <li>{@link JewishCalendar#setInIsrael(boolean)}: Israel or diaspora <em>Yom Tov</em> (one or two days) and <em>parshiyos</em>.</li>
24+
* <li>{@link JewishCalendar#setIsMukafChoma(boolean)}: whether <em>Purim</em> is observed on <em>Shushan Purim</em> (walled cities).</li>
25+
* <li>{@link JewishCalendar#setUseModernHolidays(boolean)}: whether modern Israeli holidays are included.</li>
26+
* </ul>
27+
* Instances are mutable and not thread-safe; use a separate instance per thread.
28+
*
29+
* @author &copy; Eliyahu Hershfeld 2011 - 2026
1830
*/
1931
package com.kosherjava.zmanim.hebrewcalendar;

0 commit comments

Comments
 (0)