diff --git a/Sources/KosherSwift/hebrewcalendar/Daf.swift b/Sources/KosherSwift/hebrewcalendar/Daf.swift index d722b99..7ce75f7 100644 --- a/Sources/KosherSwift/hebrewcalendar/Daf.swift +++ b/Sources/KosherSwift/hebrewcalendar/Daf.swift @@ -14,17 +14,17 @@ import Foundation */ public class Daf { /** - * {@link #getMasechtaNumber()} and {@link #setMasechtaNumber(int)}. + * ``getMasechtaNumber()`` and ``setMasechtaNumber(masechtaNumber:). */ public var masechtaNumber:Int = 0 /** - * See {@link #getDaf()} and {@link #setDaf(int)}. + * See ``getDaf()`` and ``setDaf(daf:)``. */ public var daf:Int = 0 /** - * See {@link #getMasechtaTransliterated()} and {@link #setMasechtaTransliterated(String[])}. + * See ``getMasechtaTransliterated()`` and ``setMasechtaTransliterated(masechtosBavliTransliterated:)``. */ public static var masechtosBavliTransliterated = [ "Berachos", "Shabbos", "Eruvin", "Pesachim", "Shekalim", "Yoma", "Sukkah", "Beitzah", "Rosh Hashana", "Taanis", "Megillah", "Moed Katan", "Chagigah", "Yevamos", @@ -33,7 +33,7 @@ public class Daf { "Arachin", "Temurah", "Kerisos", "Meilah", "Kinnim", "Tamid", "Midos", "Niddah" ]; /** - * See {@link #getMasechta()}. + * See ``getMasechta()``. */ private static let masechtosBavli = [ "ברקות", "שבת", "אירובים", "פסחים", "שקלים", "יומא", "סוכה", "ביצה", @@ -44,7 +44,7 @@ public class Daf { ]; /** - * See {@link #getYerushalmiMasechtaTransliterated()}. + * See ``getYerushalmiMasechtaTransliterated()``. */ public static var masechtosYerushalmiTransliterated = [ "Berachos", "Pe'ah", "Demai", "Kilayim", "Shevi'is", "Terumos", "Ma'asros", "Ma'aser Sheni", "Chalah", "Orlah", "Bikurim", "Shabbos", "Eruvin", "Pesachim", @@ -53,7 +53,7 @@ public class Daf { "Bava Basra", "Shevuos", "Makos", "Sanhedrin", "Avodah Zarah", "Horayos", "Nidah", "No Daf Today" ]; /** - * See {@link #getYerushalmiMasechta()}. + * See ``getYerushalmiMasechta()``. */ public static let masechtosYerushalmi = [ "ברכות" , "פיאה" @@ -124,8 +124,8 @@ public class Daf { } /** - * Constructor that creates a Daf setting the {@link #setMasechtaNumber(int) masechta number} and - * {@link #setDaf(int) daf number}. + * Constructor that creates a ``Daf`` setting the ``setMasechtaNumber(masechtaNumber:)`` masechta number} and + * ``setDaf(daf:)`` daf number. * * @param masechtaNumber the masechta number in the order of the Daf Yomi to set as the current masechta. * @param daf the daf (page) number to set. diff --git a/Sources/KosherSwift/hebrewcalendar/TefilaRules.swift b/Sources/KosherSwift/hebrewcalendar/TefilaRules.swift index abb1637..11305fb 100644 --- a/Sources/KosherSwift/hebrewcalendar/TefilaRules.swift +++ b/Sources/KosherSwift/hebrewcalendar/TefilaRules.swift @@ -9,18 +9,18 @@ import Foundation /** * Tefila Rules is a utility class that covers the various halachos and minhagim regarding - * changes to daily tefila / prayers, based on the Jewish calendar. self is mostly useful for use in + * changes to daily tefila / prayers, based on the Jewish calendar. This is mostly useful for use in * developing siddur type applications, but it is also valuable for shul calendars that set * tefila times based on if tachanun is - * recited that day. There are many settings in self class to cover the vast majority of minhagim, but + * recited that day. There are many settings in this class to cover the vast majority of minhagim, but * there are likely some not covered here. The source for many of the chasidishe minhagim can be found * in the Minhag Yisrael Torah on Orach * Chaim 131. * Dates used in specific communities such as specific yahrzeits or a holidays like Purim Mezhbizh - * (Medzhybizh) celebrated on 11 {@link JewishCalendar#TEVES Teves} or Teves or Purim Saragossa celebrated on - * the (17th or) 18th of {@link JewishCalendar#SHEVAT Shevat} are not (and likely will not be) supported by - * self class. + * the (17th or) 18th of ``JewishCalendar.SHEVAT`` Shevat are not (and likely will not be) supported by + * this class. * @author © Y. Paritcher 2019 - 2021 * @author © Eliyahu Hershfeld 2019 - 2023 */ @@ -120,7 +120,7 @@ public class TefilaRules { /** * Returns if tachanun is recited during shacharis on the day in question. There are the many - * minhagim based settings that are available in self class that control what days are set for + * minhagim based settings that are available in this class that control what days are set for * tachanun recital. * * @param jewishCalendar the Jewish calendar day. @@ -197,12 +197,12 @@ public class TefilaRules { /** * Returns if it is the Jewish day (starting the evening before) to start reciting Vesein Tal Umatar Livracha - * (Sheailas Geshamim). In Israel self is the 7th day of {@link JewishCalendar#CHESHVAN Marcheshvan}. + * (Sheailas Geshamim). In Israel this is the 7th day of ``JewishCalendar.CHESHVAN`` Marcheshvan}. * Outside Israel recitation starts on the evening of December 4th (or 5th if it is the year before a civil leap year) - * in the 21st century and shifts a day forward every century not evenly divisible by 400. self method will return true + * in the 21st century and shifts a day forward every century not evenly divisible by 400. This method will return true * if vesein tal umatar on the current Jewish date that starts on the previous night, so Dec 5/6 will be - * returned by self method in the 21st century. vesein tal umatar is not recited on Shabbos and the - * start date will be delayed a day when the start day is on a Shabbos (self can only occur out of Israel). + * returned by this method in the 21st century. vesein tal umatar is not recited on Shabbos and the + * start date will be delayed a day when the start day is on a Shabbos (this can only occur out of Israel). * * @param jewishCalendar the Jewish calendar day. * @@ -233,12 +233,12 @@ public class TefilaRules { /** * Returns if true if tonight is the first night to start reciting Vesein Tal Umatar Livracha ( - * Sheailas Geshamim). In Israel self is the 7th day of {@link JewishCalendar#CHESHVAN - * Marcheshvan} (so the 6th will return true). Outside Israel recitation starts on the evening + * Sheailas Geshamim). In Israel this is the 7th day of ``JewishCalendar.CHESHVAN`` + * Marcheshvan (so the 6th will return true). Outside Israel recitation starts on the evening * of December 4th (or 5th if it is the year before a civil leap year) in the 21st century and shifts a * day forward every century not evenly divisible by 400. Vesein tal umatar is not recited on * Shabbos and the start date will be delayed a day when the start day is on a Shabbos - * (self can only occur out of Israel). + * (this can only occur out of Israel). * * @param jewishCalendar the Jewish calendar day. * @@ -268,7 +268,7 @@ public class TefilaRules { } /** - * Returns if Vesein Tal Umatar Livracha (Sheailas Geshamim) is recited. self will return + * Returns if Vesein Tal Umatar Livracha (Sheailas Geshamim) is recited. this will return * true for the entire season, even on Shabbos when it is not recited. * * @param jewishCalendar the Jewish calendar day. @@ -293,8 +293,8 @@ public class TefilaRules { } /** - * Returns if Vesein Beracha is recited. It is recited from 15 {@link JewishCalendar#NISSAN Nissan} to the - * point that {@link #isVeseinTalUmatarRecited(JewishCalendar) vesein tal umatar is recited}. + * Returns if Vesein Beracha is recited. It is recited from 15 ``JewishCalendar.NISSAN`` Nissan to the + * point that ``isVeseinTalUmatarRecited(jewishCalendar:)`` vesein tal umatar is recited. * * @param jewishCalendar the Jewish calendar day. * @return true if Vesein Beracha is recited. @@ -306,7 +306,7 @@ public class TefilaRules { /** * Returns if the date is the start date for reciting Mashiv Haruach Umorid Hageshem. The date is 22 - * {@link JewishCalendar#TISHREI Tishrei}. + * ``JewishCalendar.TISHREI`` Tishrei. * * @param jewishCalendar the Jewish calendar day. * @return true if the date is the start date for reciting Mashiv Haruach Umorid Hageshem. @@ -319,7 +319,7 @@ public class TefilaRules { /** * Returns if the date is the end date for reciting Mashiv Haruach Umorid Hageshem. The date is 15 - * {@link JewishCalendar#NISSAN Nissan}. + * ``JewishCalendar.NISSAN`` Nissan. * * @param jewishCalendar the Jewish calendar day. * @return true if the date is the end date for reciting Mashiv Haruach Umorid Hageshem. @@ -331,8 +331,8 @@ public class TefilaRules { } /** - * Returns if Mashiv Haruach Umorid Hageshem is recited. self period starts on 22 {@link - * JewishCalendar#TISHREI Tishrei} and ends on the 15th day of {@link JewishCalendar#NISSAN Nissan}. + * Returns if Mashiv Haruach Umorid Hageshem is recited. this period starts on 22 + * ``JewishCalendar.TISHREI`` Tishrei and ends on the 15th day of ``JewishCalendar.NISSAN`` Nissan. * * @param jewishCalendar the Jewish calendar day. * @return true if Mashiv Haruach Umorid Hageshem is recited. @@ -347,8 +347,8 @@ public class TefilaRules { /** * Returns if Morid Hatal (or the lack of reciting Mashiv Haruach following nussach Ashkenaz) is - * recited. self period starts on the 15th day of {@link JewishCalendar#NISSAN Nissan} and ends on 22 {@link - * JewishCalendar#TISHREI Tishrei}. + * recited. this period starts on the 15th day of ``JewishCalendar.NISSAN`` Nissan and ends on 22 + * ``JewishCalendar.TISHREI`` Tishrei. * * @param jewishCalendar the Jewish calendar day. * @@ -359,8 +359,8 @@ public class TefilaRules { } /** - * Returns if Hallel is recited on the day in question. self will return true for both Hallel shalem - * and Chatzi Hallel. See {@link #isHallelShalemRecited(JewishCalendar)} to know if the complete Hallel + * Returns if Hallel is recited on the day in question. this will return true for both Hallel shalem + * and Chatzi Hallel. See ``isHallelShalemRecited(jewishCalendar:)`` to know if the complete Hallel * is recited. * * @param jewishCalendar the Jewish calendar day. @@ -406,8 +406,8 @@ public class TefilaRules { } /** - * Returns if hallel shalem is recited on the day in question. self will always return false if {@link - * #isHallelRecited(JewishCalendar)} returns false. + * Returns if hallel shalem is recited on the day in question. This will always return false if + * ``isHallelRecited(jewishCalendar:)`` returns false. * * @param jewishCalendar the Jewish calendar day. * @return if hallel shalem is recited. @@ -485,16 +485,16 @@ public class TefilaRules { } /** - * Is tachanun set to be recited during the week of Purim, from the 11th through the 17th of {@link - * JewishCalendar#ADAR Adar} (on a non-leap year, or {@link JewishCalendar#ADAR_II Adar II} on a leap year). Some - * chasidishe communities do not recite tachanun during self period. See the tachanun set to be recited during the week of Purim, from the 11th through the 17th of + * ``JewishCalendar.ADAR`` Adar (on a non-leap year, or ``JewishCalendar.ADAR_II`` Adar II on a leap year). Some + * chasidishe communities do not recite tachanun during this period. See the Minhag Yisrael Torah 131 and Darkei Chaim Veshalom 191who discuss the * minhag not to recite tachanun. Also see the Mishmeres Shalom (Hadras Shalom) who discusses the * minhag of not reciting it on the 16th and 17th. - * @return If tachanun is set to be recited during the week of Purim from the 11th through the 17th of {@link - * JewishCalendar#ADAR Adar} (on a non-leap year, or {@link JewishCalendar#ADAR_II Adar II} on a leap year). + * @return If tachanun is set to be recited during the week of Purim from the 11th through the 17th of + * ``JewishCalendar.ADAR`` Adar (on a non-leap year, or ``JewishCalendar.ADAR_II`` Adar II on a leap year). * @see #setTachanunRecitedWeekOfPurim(boolean) */ public func isTachanunRecitedWeekOfPurim() -> Bool { @@ -502,12 +502,12 @@ public class TefilaRules { } /** - * Sets if tachanun should be recited during the week of Purim from the 11th through the 17th of {@link - * JewishCalendar#ADAR Adar} (on a non-leap year), or {@link JewishCalendar#ADAR_II Adar II} (on a leap year). + * Sets if tachanun should be recited during the week of Purim from the 11th through the 17th of + * ``JewishCalendar.ADAR`` Adar (on a non-leap year), or ``JewishCalendar.ADAR_II`` Adar II (on a leap year). * @param tachanunRecitedWeekOfPurim Sets if tachanun is to recited during the week of Purim from the 11th - * through the 17th of {@link JewishCalendar#ADAR Adar} (on a non-leap year), or {@link JewishCalendar#ADAR_II - * Adar II} (on a leap year). Some chasidishe communities do not recite tachanun - * during self period. + * through the 17th of ``JewishCalendar.ADAR`` Adar (on a non-leap year), or ``JewishCalendar.ADAR_II`` + * Adar II (on a leap year). Some chasidishe communities do not recite tachanun + * during this period. * @see #isTachanunRecitedWeekOfPurim() */ public func setTachanunRecitedWeekOfPurim(tachanunRecitedWeekOfPurim:Bool) { @@ -516,10 +516,10 @@ public class TefilaRules { /** * Is tachanun set to be recited during the sefira week of Hod (14 - 20 {@link - * JewishCalendar#IYAR Iyar}, or the 29th - 35th of the {@link JewishCalendar#getDayOfOmer() Omer}). Some - * chasidishe communities do not recite tachanun during self week. See Minhag Yisrael Torah 131:Iyar. - * @return If tachanun is set to be recited during the sefira week of Hod (14 - 20 {@link - * JewishCalendar#IYAR Iyar}, or the 29th - 35th of the {@link JewishCalendar#getDayOfOmer() Omer}). + * JewishCalendar#IYAR Iyar}, or the 29th - 35th of the ``JewishCalendar.getDayOfOmer()`` Omer). Some + * chasidishe communities do not recite tachanun during this week. See Minhag Yisrael Torah 131:Iyar. + * @return If tachanun is set to be recited during the sefira week of Hod (14 - 20 + * JewishCalendar.IYAR Iyar, or the 29th - 35th of the JewishCalendar.getDayOfOmer() Omer). * @see #setTachanunRecitedWeekOfHod(boolean) */ public func isTachanunRecitedWeekOfHod() -> Bool { @@ -528,7 +528,7 @@ public class TefilaRules { /** * Sets if tachanun should should be recited during the sefira week of Hod (14 - 20 - * {@link JewishCalendar#IYAR Iyar}, or the 29th - 35th of the {@link JewishCalendar#getDayOfOmer() Omer}). + * ``JewishCalendar.IYAR`` Iyar, or the 29th - 35th of the ``JewishCalendar.getDayOfOmer()`` Omer). * @param tachanunRecitedWeekOfHod Sets if tachanun should be recited during the sefira week of * Hod. * @see #isTachanunRecitedWeekOfHod() @@ -538,14 +538,14 @@ public class TefilaRules { } /** - * Is tachanun set to be recited at the end Of {@link JewishCalendar#TISHREI Tishrei}.The Magen Avraham 669:1 and - * the Pri Chadash 131:7 state that some places to not recite tachanun during self period. The Sh"UT Chasam Sofer on - * Choshen Mishpat 77 writes that self is the minhag in Ashkenaz. The Shaarei Teshuva 131:19 quotes the Sheyarie Kneses - * Hagdola who also states that it should not be recited. The Aderes wanted to institute saying tachanun during self - * period, but was dissuaded from self by Rav Shmuel Salant who did not want to change the minhag in Yerushalayim. - * The Aruch Hashulchan is of the opinion that that self minhag is incorrect, and it should be recited, and The Chazon - * Ish also recited tachanun during self period. See the Dirshu edition of the Mishna Berurah for details. - * @return If tachanun is set to be recited at the end of {@link JewishCalendar#TISHREI Tishrei}. + * Is tachanun set to be recited at the end of ``JewishCalendar.TISHREI`` Tishrei.The Magen Avraham 669:1 and + * the Pri Chadash 131:7 state that some places to not recite tachanun during this period. The Sh"UT Chasam Sofer on + * Choshen Mishpat 77 writes that this is the minhag in Ashkenaz. The Shaarei Teshuva 131:19 quotes the Sheyarie Kneses + * Hagdola who also states that it should not be recited. The Aderes wanted to institute saying tachanun during this + * period, but was dissuaded from this by Rav Shmuel Salant who did not want to change the minhag in Yerushalayim. + * The Aruch Hashulchan is of the opinion that that this minhag is incorrect, and it should be recited, and The Chazon + * Ish also recited tachanun during this period. See the Dirshu edition of the Mishna Berurah for details. + * @return If tachanun is set to be recited at the end of ``JewishCalendar.TISHREI`` Tishrei. * @see #setTachanunRecitedEndOfTishrei(tachanunRecitedEndOfTishrei) */ public func isTachanunRecitedEndOfTishrei() -> Bool { @@ -553,8 +553,8 @@ public class TefilaRules { } /** - * Sets if tachanun should be recited at the end of {@link JewishCalendar#TISHREI Tishrei}. - * @param tachanunRecitedEndOfTishrei is tachanun recited at the end of {@link JewishCalendar#TISHREI Tishrei}. + * Sets if tachanun should be recited at the end of ``JewishCalendar.TISHREI`` Tishrei. + * @param tachanunRecitedEndOfTishrei is tachanun recited at the end of ``JewishCalendar.TISHREI`` Tishrei. * @see #isTachanunRecitedEndOfTishrei() */ public func setTachanunRecitedEndOfTishrei(tachanunRecitedEndOfTishrei:Bool) { @@ -562,10 +562,10 @@ public class TefilaRules { } /** - * Is tachanun set to be recited during the week after Shavuos. self is the opinion of the Pri - * Megadim quoted by the Mishna Berurah. self is since karbanos of Shavuos have tashlumim + * Is tachanun set to be recited during the week after Shavuos. this is the opinion of the Pri + * Megadim quoted by the Mishna Berurah. this is since karbanos of Shavuos have tashlumim * for 7 days, it is still considered like a Yom Tov. The Chazon Ish quoted in the Orchos Rabainu vol. 1 - * page 68 recited tachanun during self week. + * page 68 recited tachanun during this week. * * @return If tachanun is set to be recited during the week after Shavuos. * @see #setTachanunRecitedWeekAfterShavuos(boolean) @@ -584,16 +584,16 @@ public class TefilaRules { } /** - * Is tachanun is set to be recited on the 13th of {@link JewishCalendar#SIVAN Sivan} (tachanun is set to be recited on the 13th of ``JewishCalendar.SIVAN`` Sivan (Yom Tov Sheni shel Galuyos of the 7th - * day) outside Israel. self is brought down by the Shaarie Teshuva 131:19 quoting the Sheyarei Kneses Hagedola 131:12that - * tachanun should not be recited on self day. Rav Shlomo Zalman Orbach in Halichos Shlomo on + * tachanun should not be recited on this day. Rav Shlomo Zalman Orbach in Halichos Shlomo on * Shavuos 12:16:25 is of the opinion that even in chutz laaretz it should be recited since the yemei * Tashlumin are counted based on Israel since that is where the karbanos are brought. Both - * {@link #isTachanunRecitedShacharis(JewishCalendar)} and {@link #isTachanunRecitedMincha(JewishCalendar)} - * only return false if the location is not set to {@link JewishCalendar#getInIsrael() Israel} and both - * {@link #tachanunRecitedWeekAfterShavuos} and {@link #setTachanunRecited13SivanOutOfIsrael} are set to false. + * ``isTachanunRecitedShacharis(jewishCalendar:)`` and ``isTachanunRecitedMincha(jewishCalendar:)`` + * only return false if the location is not set to ``JewishCalendar.getInIsrael()`` Israel and both + * ``tachanunRecitedWeekAfterShavuos`` and ``setTachanunRecited13SivanOutOfIsrael(tachanunRecitedThirteenSivanOutOfIsrael:)`` are set to false. * * @return If tachanun is set to be recited on the 13th of {@link JewishCalendar#SIVAN Sivan} out of Israel. * @see #setTachanunRecited13SivanOutOfIsrael(isTachanunRecitedThirteenSivanOutOfIsrael) @@ -604,14 +604,14 @@ public class TefilaRules { } /** - * Sets if tachanun should be recited on the 13th of {@link JewishCalendar#SIVAN Sivan} (tachanun should be recited on the 13th of ``JewishCalendar.SIVAN`` Sivan (Yom Tov Sheni shel Galuyos of the 7th * day) outside Israel. - * @param tachanunRecitedThirteenSivanOutOfIsrael sets if tachanun should be recited on the 13th of {@link - * JewishCalendar#SIVAN Sivan} out of Israel. Both {@link #isTachanunRecitedShacharis(JewishCalendar)} and - * {@link #isTachanunRecitedMincha(JewishCalendar)} only return false if the location is not set to {@link - * JewishCalendar#getInIsrael() Israel} and both {@link #tachanunRecitedWeekAfterShavuos} and - * {@link #setTachanunRecited13SivanOutOfIsrael} are set to false. + * @param tachanunRecitedThirteenSivanOutOfIsrael sets if tachanun should be recited on the 13th of + * ``JewishCalendar.SIVAN`` Sivan out of Israel. Both ``isTachanunRecitedShacharis(jewishCalendar:)`` and + * ``isTachanunRecitedMincha(jewishCalendar:)`` only return false if the location is not set to + * ``JewishCalendar.getInIsrael()`` Israel and both ``tachanunRecitedWeekAfterShavuos`` and + * ``setTachanunRecited13SivanOutOfIsrael(tachanunRecitedThirteenSivanOutOfIsrael:)`` are set to false. * @see #isTachanunRecited13SivanOutOfIsrael() */ public func setTachanunRecited13SivanOutOfIsrael(tachanunRecitedThirteenSivanOutOfIsrael:Bool) { @@ -619,14 +619,14 @@ public class TefilaRules { } /** - * Is tachanun set to be recited on {@link JewishCalendar#PESACH_SHENI Pesach Sheni}. The Pri Chadash 131:7 - * states that tachanun should not be recited. The Aruch Hashulchan states that self is the minhag of the + * Is tachanun set to be recited on ``JewishCalendar.PESACH_SHENI`` Pesach Sheni. The Pri Chadash 131:7 + * states that tachanun should not be recited. The Aruch Hashulchan states that this is the minhag of the * sephardim. The Shaarei Efraim 10:27 also mentions that it is not recited, as does the Siddur Yaavetz (Shaar Hayesod, * Chodesh Iyar). The Pri Megadim (Mishbetzes Hazahav 131:15) and the Chazon Ish (Erev Pesahc Shchal Beshabos, page 203 in * Rav Sheraya * Devlitzky's comments). * - * @return If tachanun is set to be recited on {@link JewishCalendar#PESACH_SHENI Pesach Sheni}. + * @return If tachanun is set to be recited on ``JewishCalendar.PESACH_SHENI`` Pesach Sheni. * @see #setTachanunRecitedPesachSheni(boolean) */ public func isTachanunRecitedPesachSheni() -> Bool { @@ -634,7 +634,7 @@ public class TefilaRules { } /** - * Sets if tachanun should be recited on {@link JewishCalendar#PESACH_SHENI Pesach Sheni}. + * Sets if tachanun should be recited on ``JewishCalendar.PESACH_SHENI`` Pesach Sheni. * @param tachanunRecitedPesachSheni sets if tachanun should be recited on Pesach Sheni. * @see #isTachanunRecitedPesachSheni() */ @@ -643,13 +643,13 @@ public class TefilaRules { } /** - * Is tachanun set to be recited on 15 {@link JewishCalendar#IYAR Iyar} (sfaika deyoma of {@link - * JewishCalendar#PESACH_SHENI Pesach Sheni}) out of Israel. If {@link #isTachanunRecitedPesachSheni()} is - * true self will be ignored even if false. + * Is tachanun set to be recited on 15 ``JewishCalendar.IYAR`` Iyar (sfaika deyoma of + * ``JewishCalendar.PESACH_SHENI`` Pesach Sheni) out of Israel. If ``isTachanunRecitedPesachSheni()`` is + * true this will be ignored even if false. * - * @return if tachanun is set to be recited on 15 {@link JewishCalendar#IYAR Iyar} (sfaika deyoma - * of {@link JewishCalendar#PESACH_SHENI Pesach Sheni} out of Israel. If - * {@link #isTachanunRecitedPesachSheni()} is true self will be ignored even if false. + * @return if tachanun is set to be recited on 15 ``JewishCalendar.IYAR`` Iyar (sfaika deyoma + * of``JewishCalendar.PESACH_SHENI`` Pesach Sheni out of Israel. If + * ``isTachanunRecitedPesachSheni()`` is true this will be ignored even if false. * @see #setTachanunRecited15IyarOutOfIsrael(boolean) * @see #setTachanunRecitedPesachSheni(boolean) * @see #isTachanunRecitedPesachSheni() @@ -659,13 +659,13 @@ public class TefilaRules { } /** - * Sets if tachanun should be recited on the 15th of {@link JewishCalendar#IYAR Iyar} (tachanun should be recited on the 15th of ``JewishCalendar.IYAR`` Iyar (Yom Tov Sheni shel Galuyos of - * {@link JewishCalendar#PESACH_SHENI Pesach Sheni}) out of Israel. Ignored if {@link - * #isTachanunRecitedPesachSheni()} is true. + * ``JewishCalendar.PESACH_SHENI`` Pesach Sheni) out of Israel. Ignored if + * ``isTachanunRecitedPesachSheni()`` is true. * - * @param tachanunRecited15IyarOutOfIsrael if tachanun should be recited on the 15th of {@link JewishCalendar#IYAR - * Iyar} (sfaika deyoma of {@link JewishCalendar#PESACH_SHENI Pesach Sheni}) out of Israel. + * @param tachanunRecited15IyarOutOfIsrael if tachanun should be recited on the 15th of ``JewishCalendar.IYAR`` + * Iyar (sfaika deyoma of ``JewishCalendar.PESACH_SHENI`` Pesach Sheni) out of Israel. * @see #isTachanunRecited15IyarOutOfIsrael() */ public func setTachanunRecited15IyarOutOfIsrael(tachanunRecited15IyarOutOfIsrael:Bool) { @@ -673,10 +673,10 @@ public class TefilaRules { } /** - * Is tachanun set to be recited on mincha on erev {@link JewishCalendar#LAG_BAOMER Lag - * Baomer}. + * Is tachanun set to be recited on mincha on erev ``JewishCalendar.LAG_BAOMER`` Lag + * Baomer. * @return if tachanun is set to be recited in mincha on erev - * {@link JewishCalendar#LAG_BAOMER Lag Baomer}. + * ``JewishCalendar.LAG_BAOMER`` Lag Baomer. * @see #setTachanunRecitedMinchaErevLagBaomer(boolean) */ public func isTachanunRecitedMinchaErevLagBaomer() -> Bool { @@ -684,9 +684,9 @@ public class TefilaRules { } /** - * Sets if tachanun should be recited on erev {@link JewishCalendar#LAG_BAOMER Lag Baomer}. + * Sets if tachanun should be recited on erev ``JewishCalendar.LAG_BAOMER`` Lag Baomer. * @param tachanunRecitedMinchaErevLagBaomer sets if tachanun should be recited on mincha - * of erev {@link JewishCalendar#LAG_BAOMER Lag Baomer}. + * of erev ``JewishCalendar.LAG_BAOMER`` Lag Baomer. * @see #isTachanunRecitedMinchaErevLagBaomer() */ public func setTachanunRecitedMinchaErevLagBaomer(tachanunRecitedMinchaErevLagBaomer: Bool) { @@ -694,14 +694,14 @@ public class TefilaRules { } /** - * Is tachanun set to be recited during the Shivas Yemei Hamiluim, from the 23 of {@link - * JewishCalendar#ADAR Adar} on a non-leap-year or {@link JewishCalendar#ADAR_II Adar II} on a + * Is tachanun set to be recited during the Shivas Yemei Hamiluim, from the 23 of + * ``JewishCalendar.ADAR`` Adar on a non-leap-year or ``JewishCalendar.ADAR_II`` Adar II on a * leap year to the end of the month. Some chasidishe communities do not say tachanun - * during self week. See Darkei + * during this week. See Darkei * Chaim Veshalom 191. * @return if tachanun is set to be recited during the Shivas Yemei Hamiluim, from the 23 - * of {@link JewishCalendar#ADAR Adar} on a non-leap-year or {@link JewishCalendar#ADAR_II - * Adar II} on a leap year to the end of the month. + * of ``JewishCalendar.ADAR`` Adar on a non-leap-year or ``JewishCalendar.ADAR_II`` + * Adar II on a leap year to the end of the month. * @see #setTachanunRecitedShivasYemeiHamiluim(boolean) */ public func isTachanunRecitedShivasYemeiHamiluim() -> Bool { @@ -710,7 +710,7 @@ public class TefilaRules { /** * Sets if tachanun should be recited during the Shivas Yemei Hamiluim, from the 23 of - * {@link JewishCalendar#ADAR Adar} on a non-leap-year or {@link JewishCalendar#ADAR_II Adar II} + * ``JewishCalendar.ADAR`` Adar on a non-leap-year or ``JewishCalendar.ADAR_II`` Adar II * on a leap year to the end of the month. * @param tachanunRecitedShivasYemeiHamiluim sets if tachanun should be recited during the * Shivas Yemei Hamiluim. @@ -723,7 +723,7 @@ public class TefilaRules { /** * Is tachanun set to be recited on Fridays. Some chasidishe communities do not recite * tachanun on Fridays. See Likutei - * Maharich Vol 2 Seder Hanhagos Erev Shabbos. self is also the minhag in Satmar. + * Maharich Vol 2 Seder Hanhagos Erev Shabbos. this is also the minhag in Satmar. * @return if tachanun is set to be recited on Fridays. * @see #setTachanunRecitedFridays(boolean) */ @@ -776,7 +776,7 @@ public class TefilaRules { /** * Sets if tachanun should be recited in Mincha the entire year. * @param tachanunRecitedMinchaAllYear sets if tachanun should be recited by mincha all year. If set - * to false, {@link #isTachanunRecitedMincha(JewishCalendar)} will always return false. If set to true (the + * to false, ``isTachanunRecitedMincha(jewishCalendar:)`` will always return false. If set to true (the * default), it will use the regular rules. * @see #isTachanunRecitedMinchaAllYear() */ diff --git a/Sources/KosherSwift/hebrewcalendar/YerushalmiYomiCalculator.swift b/Sources/KosherSwift/hebrewcalendar/YerushalmiYomiCalculator.swift index ce99f54..b603050 100644 --- a/Sources/KosherSwift/hebrewcalendar/YerushalmiYomiCalculator.swift +++ b/Sources/KosherSwift/hebrewcalendar/YerushalmiYomiCalculator.swift @@ -9,7 +9,7 @@ import Foundation /** * This class calculates the Talmud Yerusalmi Daf Yomi page ({@link Daf}) for the a given date. + * "https://en.wikipedia.org/wiki/Daf_Yomi">Daf Yomi page (``Daf``) for the a given date. * * @author © elihaidv * @author © Eliyahu Hershfeld 2017 - 2023 @@ -20,10 +20,13 @@ public class YerushalmiYomiCalculator { * The start date of the first Daf Yomi Yerushalmi cycle of February 2, 1980 / 15 Shevat, 5740. */ private static let DAF_YOMI_START_DAY = gregorianDate(forYear: 1980, month: 2, andDay: 2) + /** The number of milliseconds in a day. */ private static let DAY_MILIS = 1000 * 60 * 60 * 24 + /** The number of pages in the Talmud Yerushalmi.*/ private static let WHOLE_SHAS_DAFS = 1554 + /** The number of pages per masechta (tractate).*/ private static let BLATT_PER_MASECHTA = [ 68, 37, 34, 44, 31, 59, 26, 33, 28, 20, 13, 92, 65, 71, 22, 22, 42, 26, 26, 33, 34, 22, @@ -31,17 +34,15 @@ public class YerushalmiYomiCalculator { /** * Returns the Daf Yomi - * Yerusalmi page ({@link Daf}) for a given date. + * Yerusalmi page (``Daf``) for a given date. * The first Daf Yomi cycle started on 15 Shevat (Tu Bishvat), 5740 (February, 2, 1980) and calculations * prior to this date will result in an nil. A nil will be returned on Tisha B'Av or * Yom Kippur. * * @param calendar * the calendar date for calculation - * @return the {@link Daf} or null if the date is on Tisha B'Av or Yom Kippur. + * @return the ``Daf`` or nil if the date is on Tisha B'Av or Yom Kippur, or if the date is prior to the February 2, 1980, the start of the first Daf Yomi Yerushalmi cycle * - * @throws IllegalArgumentException - * if the date is prior to the February 2, 1980, the start of the first Daf Yomi Yerushalmi cycle */ public static func getDafYomiYerushalmi(jewishCalendar:JewishCalendar) -> Daf? { let dateCreator = Calendar(identifier: .gregorian) diff --git a/Sources/KosherSwift/hebrewcalendar/YomiCalculator.swift b/Sources/KosherSwift/hebrewcalendar/YomiCalculator.swift index 93cb645..45602cc 100644 --- a/Sources/KosherSwift/hebrewcalendar/YomiCalculator.swift +++ b/Sources/KosherSwift/hebrewcalendar/YomiCalculator.swift @@ -8,8 +8,8 @@ import Foundation /** - * This class calculates the Daf Yomi Bavli page (daf) for a given date. To calculate Daf Yomi Yerushalmi - * use the {@link YerushalmiYomiCalculator}. The library may cover Mishna Yomi etc. at some point in the future. + * This class calculates the ``Daf`` Yomi Bavli page (daf) for a given date. To calculate Daf Yomi Yerushalmi + * use the ``YerushalmiYomiCalculator``. The library may cover Mishna Yomi etc. at some point in the future. * * @author © Bob Newell (original C code) * @author © Eliyahu Hershfeld 2011 - 2020 @@ -20,24 +20,28 @@ public class YomiCalculator { * The start date of the first Daf Yomi Bavli cycle of September 11, 1923 / Rosh Hashana 5684. */ private static let dafYomiStartDay = gregorianDate(forYear: 1923, month: 9, andDay: 11)!; + /** The start date of the first Daf Yomi Bavli cycle in the Julian calendar. Used internally for claculations.*/ private static let dafYomiJulianStartDay = getJulianDay(date: dafYomiStartDay); + /** * The date that the pagination for the Daf Yomi Maseches Shekalim changed to use the commonly used Vilna * Shas pagination from the no longer commonly available Zhitomir / Slavuta Shas used by Rabbi Meir Shapiro. */ private static let shekalimChangeDay = gregorianDate(forYear: 1975, month: 6, andDay: 24)!; - /** The Julian date that the cycle for Shekalim changed. + /** + * The Julian date that the cycle for Shekalim changed. + * * @see #getDafYomiBavli(JewishCalendar) for details. */ private static let shekalimJulianChangeDay = getJulianDay(date: shekalimChangeDay); /** * Returns the Daf Yomi Bavli {@link Daf} for a given date. The first Daf Yomi cycle + * href="http://en.wikipedia.org/wiki/Talmud">Bavli ``Daf`` for a given date. The first Daf Yomi cycle * started on Rosh Hashana 5684 (September 11, 1923) and calculations prior to this date will result in an - * IllegalArgumentException thrown. For historical calculations (supported by this method), it is important to note + * nil returned. For historical calculations (supported by this method), it is important to note * that a change in length of the cycle was instituted starting in the eighth Daf Yomi cycle beginning on June 24, * 1975. The Daf Yomi Bavli cycle has a single masechta of the Talmud Yerushalmi - Shekalim as part of the cycle. * Unlike the Bavli where the number of daf per masechta was standardized since the original Vilna Shas that is in common use today. * * @param jewishCalendar - * The JewishCalendar date for calculation. TODO: this can be changed to use a regular GregorianCalendar since + * The ``JewishCalendar`` date for calculation. TODO: this can be changed to use a regular GregorianCalendar since * there is nothing specific to the JewishCalendar in this class. - * @return the {@link Daf} or nil if before the bavli start date + * @return the ``Daf`` or nil if before the bavli start date * */ public static func getDafYomiBavli(jewishCalendar: JewishCalendar) -> Daf? {