Many Javadoc tweaks, deprecate GeoLocationUtils

KosherJava · KosherJava · commit c8dd09feaceb · 2020-11-23T00:13:06.000-05:00
The javadoc tool no longer complains about anything empty. The only
remaining issue seems to be a bug with the javadoc tool that complains
about legitimate (and needed) lang attributes in html elements.
Thankfully the elements make it to the documentation properly.
diff --git a/src/main/java/com/kosherjava/zmanim/AstronomicalCalendar.java b/src/main/java/com/kosherjava/zmanim/AstronomicalCalendar.java
@@ -109,8 +109,14 @@ public class AstronomicalCalendar implements Cloneable {
 	 */
 	private Calendar calendar;
 
+	/**
+	 * the {@link GeoLocation} used for calculations.
+	 */
 	private GeoLocation geoLocation;
 
+	/**
+	 * the internal {@link AstronomicalCalculator} used for calculating solar based times.
+	 */
 	private AstronomicalCalculator astronomicalCalculator;
 
 	/**
@@ -601,7 +607,6 @@ public double getSunriseSolarDipFromOffset(double minutes) {
 				degrees = degrees.subtract(incrementor);
 			}
 			offsetByDegrees = getSunriseOffsetByDegrees(GEOMETRIC_ZENITH + degrees.doubleValue());
-			//System.out.println("offsetByDegrees: " + offsetByDegrees);
 		}
 		return degrees.doubleValue();
 	}
@@ -634,6 +639,31 @@ public double getSunsetSolarDipFromOffset(double minutes) {
 		return degrees.doubleValue();
 	}
 	
+	/**
+	 * FIXME broken for czc.getRiseSetSolarDipFromOffset(-72, czc.getSunrise());
+	 * and boken in other was as well
+	 * @param minutes
+	 * @param riseSet
+	 * @return
+	 */
+	/*public double getRiseSetSolarDipFromOffset(double minutes, Date riseSet) {
+		Date offsetByDegrees = riseSet;
+		Date offsetByTime = getTimeOffset(riseSet, minutes * MINUTE_MILLIS);
+		BigDecimal degrees = new BigDecimal(0);
+		BigDecimal incrementor = new BigDecimal("0.001");
+		while (offsetByDegrees == null || ((minutes > 0.0 && offsetByDegrees.getTime() < offsetByTime.getTime()) ||
+				(minutes < 0.0 && offsetByDegrees.getTime() > offsetByTime.getTime()))) {
+			if(minutes > 0.0) {
+				degrees = degrees.add(incrementor);
+			} else {
+				degrees = degrees.subtract(incrementor);
+			}
+			offsetByDegrees = getSunsetOffsetByDegrees(GEOMETRIC_ZENITH + degrees.doubleValue());
+		}
+		return degrees.doubleValue();
+	}*/
+	
+	
 	/**
 	 * Adjusts the <code>Calendar</code> to deal with edge cases where the location crosses the antimeridian.
 	 * 
diff --git a/src/main/java/com/kosherjava/zmanim/ComplexZmanimCalendar.java b/src/main/java/com/kosherjava/zmanim/ComplexZmanimCalendar.java
@@ -414,6 +414,14 @@ public class ComplexZmanimCalendar extends ZmanimCalendar {
 	 */
 	private double ateretTorahSunsetOffset = 40;
 
+	/**
+	 * A constructor that takes a {@link GeoLocation} as a parameter.
+	 * 
+	 * @param location
+	 *            the location
+	 * 
+	 * @see ZmanimCalendar#ZmanimCalendar(GeoLocation)
+	 */
 	public ComplexZmanimCalendar(GeoLocation location) {
 		super(location);
 	}
diff --git a/src/main/java/com/kosherjava/zmanim/hebrewcalendar/JewishCalendar.java b/src/main/java/com/kosherjava/zmanim/hebrewcalendar/JewishCalendar.java
@@ -46,51 +46,131 @@
  * @author &copy; Eliyahu Hershfeld 2011 - 2020
  */
 public class JewishCalendar extends JewishDate {
+	/** The 14th day of Nisan, the day before of Pesach (Passover).*/
 	public static final int EREV_PESACH = 0;
+	/** The holiday of Pesach (Passover) on the 15th (and 16th out of Israel) day of Nisan.*/
 	public static final int PESACH = 1;
+	/** Chol Hamoed (interim days) of Pesach (Passover)*/
 	public static final int CHOL_HAMOED_PESACH = 2;
+	/**Pesach Sheni, the 14th day of Iyar, a minor holiday.*/
 	public static final int PESACH_SHENI = 3;
+	/**Erev Shavuos (the day before Shavuos), the 5th of Sivan*/
 	public static final int EREV_SHAVUOS = 4;
+	/**Shavuos (Pentecost), the 6th of Sivan*/
 	public static final int SHAVUOS = 5;
+	/** The fast of the 17th day of Tamuz*/
 	public static final int SEVENTEEN_OF_TAMMUZ = 6;
+	/** The fast of the 9th of Av*/
 	public static final int TISHA_BEAV = 7;
+	/** The 15th day of Av, a minor holiday*/
 	public static final int TU_BEAV = 8;
+	/**Erev Rosh Hashana (the day before Rosh Hashana), the 29th of Elul*/
 	public static final int EREV_ROSH_HASHANA = 9;
+	/** Rosh Hashana, the first of Tishrei.*/
 	public static final int ROSH_HASHANA = 10;
+	/** The fast of Gedalyah, the 3rd of Tishrei.*/
 	public static final int FAST_OF_GEDALYAH = 11;
+	/** The 9th day of Tishrei, the day before of Yom Kippur.*/
 	public static final int EREV_YOM_KIPPUR = 12;
+	/** The holiday of Yom Kippur, the 10th day of Tishrei*/
 	public static final int YOM_KIPPUR = 13;
+	/** The 14th day of Tishrei, the day before of Succos/Sukkos (Tabernacles).*/
 	public static final int EREV_SUCCOS = 14;
+	/** The holiday of Succos/Sukkos (Tabernacles), the 15th (and 16th out of Israel) day of Tishrei */
 	public static final int SUCCOS = 15;
+	/** Chol Hamoed (interim days) of Succos/Sukkos (Tabernacles)*/
 	public static final int CHOL_HAMOED_SUCCOS = 16;
+	/** Hoshana Rabba, the 7th day of Succos/Sukkos that occurs on the 21st of Tishrei. */
 	public static final int HOSHANA_RABBA = 17;
+	/** Shmini Atzeres, the 8th day of Succos/Sukkos is an independent holiday that occurs on the 22nd of Tishrei. */
 	public static final int SHEMINI_ATZERES = 18;
+	/** Simchas Torah, the 9th day of Succos/Sukkos, or the second day of Shmini Atzeres that is celebrated
+	 * {@link #getInIsrael() out of Israel} on the 23rd of Tishrei.
+	 */
 	public static final int SIMCHAS_TORAH = 19;
 	// public static final int EREV_CHANUKAH = 20;// probably remove this
+	/** The holiday of Chanukah. 8 days starting on the 25th day Kislev.*/
 	public static final int CHANUKAH = 21;
+	/** The fast of the 10th day of Teves.*/
 	public static final int TENTH_OF_TEVES = 22;
+	/** Tu Bishvat on the 15th day of Shevat, a minor holiday.*/
 	public static final int TU_BESHVAT = 23;
+	/** The fast of Esther, usually on the 13th day of Adar (or Adar II on leap years). It is earlier on some years.*/
 	public static final int FAST_OF_ESTHER = 24;
+	/** The holiday of Purim on the 14th day of Adar (or Adar II on leap years).*/
 	public static final int PURIM = 25;
+	/** The holiday of Shushan Purim on the 15th day of Adar (or Adar II on leap years).*/
 	public static final int SHUSHAN_PURIM = 26;
+	/** The holiday of Purim Katan on the 14th day of Adar I on a leap year when Purim is on Adar II, a minor holiday.*/
 	public static final int PURIM_KATAN = 27;
+	/**
+	 * Rosh Chodesh, the new moon on the first day of the Jewish month, and the 30th day of the previous month in the
+	 * case of a month with 30 days.
+	 */
 	public static final int ROSH_CHODESH = 28;
+	/** Yom HaShoah, Holocaust Remembrance Day, usually held on the 27th of Nisan. If it falls on a Friday, it is moved
+	 * to the 26th, and if it falls on a Sunday it is moved to the 28th. A {@link #isUseModernHolidays() modern holiday}.
+	 */
 	public static final int YOM_HASHOAH = 29;
+	/**
+	 * Yom HaZikaron, Israeli Memorial Day, held a day before Yom Ha'atzmaut.  A {@link #isUseModernHolidays() modern holiday}.
+	 */
 	public static final int YOM_HAZIKARON = 30;
+	
+	/** Yom Ha'atzmaut, Israel Independence Day, the 5th of Iyar, but if it occurs on a Friday or Saturday, the holiday is
+	 * moved back to Thursday, the 3rd of 4th of Iyar, and if it falls on a Monday, it is moved forward to Tuesday the
+	 * 6th of Iyar.  A {@link #isUseModernHolidays() modern holiday}.*/
 	public static final int YOM_HAATZMAUT = 31;
+	/**
+	 * Yom Yerushalayim or Jerusalem Day, on 28 Iyar. A {@link #isUseModernHolidays() modern holiday}.
+	 */
 	public static final int YOM_YERUSHALAYIM = 32;
+	
+	/** The 33rd day of the Omer, the 18th of Iyar, a minor holiday.*/
 	public static final int LAG_BAOMER = 33;
+	
+	/** The holiday of Purim Katan on the 15th day of Adar I on a leap year when Purim is on Adar II, a minor holiday.*/
 	public static final int SHUSHAN_PURIM_KATAN = 34;
 
+	/**
+	 * Is the calendar set to Israel, where some holidays have different rules.
+	 * @see #getInIsrael()
+	 * @see #setInIsrael(boolean)
+	 */
 	private boolean inIsrael = false;
+	
+	/**
+	 * Is the calendar set to use modern Israeli holidays such as Yom Haatzmaut.
+	 * @see #isUseModernHolidays()
+	 * @see #setUseModernHolidays(boolean)
+	 */
 	private boolean useModernHolidays = false;
 
 	/**
-	 * The {@link #VZOS_HABERACHA} enum exists for consistency, but is not currently used.
+	 * List of <em>parshiyos</em>. {@link #NONE} indicates a week without a <em>parsha</em>, while the enum for the <em>parsha</em> of
+	 * {@link #VZOS_HABERACHA} exists for consistency, but is not currently used.
 	 */
 	public static enum Parsha {
-		NONE, BERESHIS, NOACH, LECH_LECHA, VAYERA, CHAYEI_SARA, TOLDOS, VAYETZEI, VAYISHLACH, VAYESHEV, MIKETZ, VAYIGASH, VAYECHI, SHEMOS, VAERA, BO, BESHALACH, YISRO, MISHPATIM, TERUMAH, TETZAVEH, KI_SISA, VAYAKHEL, PEKUDEI, VAYIKRA, TZAV, SHMINI, TAZRIA, METZORA, ACHREI_MOS, KEDOSHIM, EMOR, BEHAR, BECHUKOSAI, BAMIDBAR, NASSO, BEHAALOSCHA, SHLACH, KORACH, CHUKAS, BALAK, PINCHAS, MATOS, MASEI, DEVARIM, VAESCHANAN, EIKEV, REEH, SHOFTIM, KI_SEITZEI, KI_SAVO, NITZAVIM, VAYEILECH, HAAZINU, VZOS_HABERACHA, VAYAKHEL_PEKUDEI, TAZRIA_METZORA, ACHREI_MOS_KEDOSHIM, BEHAR_BECHUKOSAI, CHUKAS_BALAK, MATOS_MASEI, NITZAVIM_VAYEILECH, SHKALIM, ZACHOR, PARA, HACHODESH
+		/**NONE A week without any <em>parsha</em> such as <em>Shabbos Chol Hamoed</em> */NONE,
+		/**BERESHIS*/BERESHIS, /**NOACH*/NOACH, /**LECH_LECHA*/LECH_LECHA, /**VAYERA*/VAYERA, /**CHAYEI_SARA*/CHAYEI_SARA, /**TOLDOS*/TOLDOS, 
+		/**VAYETZEI*/VAYETZEI, /**VAYISHLACH*/VAYISHLACH, /**VAYESHEV*/VAYESHEV, /**MIKETZ*/MIKETZ, /**VAYIGASH*/VAYIGASH, /**VAYECHI*/VAYECHI,
+		/**SHEMOS*/SHEMOS, /**VAERA*/VAERA, /**BO*/BO, /**BESHALACH*/BESHALACH, /**YISRO*/YISRO, /**MISHPATIM*/MISHPATIM, /**TERUMAH*/TERUMAH,
+		/**TETZAVEH*/TETZAVEH, /***KI_SISA*/KI_SISA, /**VAYAKHEL*/VAYAKHEL, /**PEKUDEI*/PEKUDEI, /**VAYIKRA*/VAYIKRA, /**TZAV*/TZAV, /**SHMINI*/SHMINI, 
+		/**TAZRIA*/TAZRIA, /**METZORA*/METZORA, /**ACHREI_MOS*/ACHREI_MOS, /**KEDOSHIM*/KEDOSHIM, /**EMOR*/EMOR, /**BEHAR*/BEHAR, /**BECHUKOSAI*/BECHUKOSAI,
+		/**BAMIDBAR*/BAMIDBAR, /**NASSO*/NASSO, /**BEHAALOSCHA*/BEHAALOSCHA, /**SHLACH*/SHLACH, /**KORACH*/KORACH, /**CHUKAS*/CHUKAS, /**BALAK*/BALAK,
+		/**PINCHAS*/PINCHAS, /**MATOS*/MATOS, /**MASEI*/MASEI, /**DEVARIM*/DEVARIM, /**VAESCHANAN*/VAESCHANAN, /**EIKEV*/EIKEV, /**REEH*/REEH,
+		/**SHOFTIM*/SHOFTIM, /**KI_SEITZEI*/KI_SEITZEI, /**KI_SAVO*/KI_SAVO, /**NITZAVIM*/NITZAVIM, /**VAYEILECH*/VAYEILECH, /**HAAZINU*/HAAZINU,
+		/**VZOS_HABERACHA*/VZOS_HABERACHA, /**The double parsha of Vayakhel &amp; Peudei*/VAYAKHEL_PEKUDEI, /**The double <em>parsha</em> of Tazria
+		 * &amp; Metzora*/TAZRIA_METZORA,/**The double <em>parsha</em> of Achrei Mos &amp; Kedoshim*/ACHREI_MOS_KEDOSHIM,/**The double <em>parsha</em>
+		 * of Behar &amp; Bechukosai*/BEHAR_BECHUKOSAI,/**The double <em>parsha</em> of Chukas &amp; Balak*/CHUKAS_BALAK, /**The double
+		 * <em>parsha</em> of Matos &amp; Masei*/MATOS_MASEI,/**The double <em>parsha</em> of Nitzavim &amp; Vayelech*/NITZAVIM_VAYEILECH,
+		 /**The special <em>parsha</em> of Shekalim*/SHKALIM, /** The special <em>parsha</em> of Zachor*/ZACHOR, /**The special <em>parsha</em> of
+		  * Para*/PARA, /** The special <em>parsha</em> of Hachodesh*/HACHODESH
 	};
+	
+	/**
+	 * An array of <em>parshiyos</em> in the 17 possible combinations.
+	 */
 	public static final Parsha[][] parshalist = {
 		{Parsha.NONE, Parsha.VAYEILECH, Parsha.HAAZINU, Parsha.NONE, Parsha.BERESHIS, Parsha.NOACH, Parsha.LECH_LECHA, Parsha.VAYERA, Parsha.CHAYEI_SARA, Parsha.TOLDOS, Parsha.VAYETZEI, Parsha.VAYISHLACH, Parsha.VAYESHEV, Parsha.MIKETZ, Parsha.VAYIGASH, Parsha.VAYECHI, Parsha.SHEMOS, Parsha.VAERA, Parsha.BO, Parsha.BESHALACH, Parsha.YISRO, Parsha.MISHPATIM, Parsha.TERUMAH, Parsha.TETZAVEH, Parsha.KI_SISA, Parsha.VAYAKHEL_PEKUDEI, Parsha.VAYIKRA, Parsha.TZAV, Parsha.NONE, Parsha.SHMINI, Parsha.TAZRIA_METZORA, Parsha.ACHREI_MOS_KEDOSHIM, Parsha.EMOR, Parsha.BEHAR_BECHUKOSAI, Parsha.BAMIDBAR, Parsha.NASSO, Parsha.BEHAALOSCHA, Parsha.SHLACH, Parsha.KORACH, Parsha.CHUKAS, Parsha.BALAK, Parsha.PINCHAS, Parsha.MATOS_MASEI, Parsha.DEVARIM, Parsha.VAESCHANAN, Parsha.EIKEV, Parsha.REEH, Parsha.SHOFTIM, Parsha.KI_SEITZEI, Parsha.KI_SAVO, Parsha.NITZAVIM_VAYEILECH},
 		{Parsha.NONE, Parsha.VAYEILECH, Parsha.HAAZINU, Parsha.NONE, Parsha.BERESHIS, Parsha.NOACH, Parsha.LECH_LECHA, Parsha.VAYERA, Parsha.CHAYEI_SARA, Parsha.TOLDOS, Parsha.VAYETZEI, Parsha.VAYISHLACH, Parsha.VAYESHEV, Parsha.MIKETZ, Parsha.VAYIGASH, Parsha.VAYECHI, Parsha.SHEMOS, Parsha.VAERA, Parsha.BO, Parsha.BESHALACH, Parsha.YISRO, Parsha.MISHPATIM, Parsha.TERUMAH, Parsha.TETZAVEH, Parsha.KI_SISA, Parsha.VAYAKHEL_PEKUDEI, Parsha.VAYIKRA, Parsha.TZAV, Parsha.NONE, Parsha.SHMINI, Parsha.TAZRIA_METZORA, Parsha.ACHREI_MOS_KEDOSHIM, Parsha.EMOR, Parsha.BEHAR_BECHUKOSAI, Parsha.BAMIDBAR, Parsha.NONE, Parsha.NASSO, Parsha.BEHAALOSCHA, Parsha.SHLACH, Parsha.KORACH, Parsha.CHUKAS_BALAK, Parsha.PINCHAS, Parsha.MATOS_MASEI, Parsha.DEVARIM, Parsha.VAESCHANAN, Parsha.EIKEV, Parsha.REEH, Parsha.SHOFTIM, Parsha.KI_SEITZEI, Parsha.KI_SAVO, Parsha.NITZAVIM_VAYEILECH},
diff --git a/src/main/java/com/kosherjava/zmanim/hebrewcalendar/JewishDate.java b/src/main/java/com/kosherjava/zmanim/hebrewcalendar/JewishDate.java
@@ -148,9 +148,14 @@ public class JewishDate implements Comparable<JewishDate>, Cloneable {
 	 */
 	private static final int JEWISH_EPOCH = -1373429;
 
+	/** The number  of <em>chalakim</em> (18) in a minute.*/
 	private static final int CHALAKIM_PER_MINUTE = 18;
+	/** The number  of <em>chalakim</em> (1080) in an hour.*/
 	private static final int CHALAKIM_PER_HOUR = 1080;
+	/** The number of <em>chalakim</em> (25,920) in a 24 hour day .*/
 	private static final int CHALAKIM_PER_DAY = 25920; // 24 * 1080
+	/** The number  of <em>chalakim</em> in an average Jewish month. A month has 29 days, 12 hours and 793
+	 * <em>chalakim</em> (44 minutes and 3.3 seconds) for a total of 765,433 <em>chalakim</em>*/
 	private static final long CHALAKIM_PER_MONTH = 765433; // (29 * 24 + 12) * 1080 + 793
 	/**
 	 * Days from the beginning of Sunday till molad BaHaRaD. Calculated as 1 day, 5 hours and 204 chalakim = (24 + 5) *
@@ -182,11 +187,17 @@ public class JewishDate implements Comparable<JewishDate>, Cloneable {
 	 */
 	public static final int SHELAIMIM = 2;
 
+	/** the internal Jewish month.*/
 	private int jewishMonth;
+	/** the internal Jewish day.*/
 	private int jewishDay;
+	/** the internal Jewish year.*/
 	private int jewishYear;
+	/** the internal count of <em>molad</em> hours.*/
 	private int moladHours;
+	/** the internal count of <em>molad</em> minutes.*/
 	private int moladMinutes;
+	/** the internal count of <em>molad</em> <em>chalakim</em>.*/
 	private int moladChalakim;
 
 	/**
@@ -305,6 +316,10 @@ int getLastDayOfGregorianMonth(int month) {
 	/** 1 == Sunday, 2 == Monday, etc... */
 	private int dayOfWeek;
 
+	/** Returns the absolute date (days since January 1, 0001 on the Gregorian calendar).
+	 * @see #getAbsDate()
+	 * @see #absDateToJewishDate()
+	 */
 	private int gregorianAbsDate;
 
 	/**
@@ -800,7 +815,7 @@ public int getDaysInJewishMonth() {
 	}
 
 	/**
-	 * Computes the Jewish date from the absolute date. ND+ER
+	 * Computes the Jewish date from the absolute date.
 	 */
 	private void absDateToJewishDate() {
 		// Approximation from below
diff --git a/src/main/java/com/kosherjava/zmanim/hebrewcalendar/YerushalmiYomiCalculator.java b/src/main/java/com/kosherjava/zmanim/hebrewcalendar/YerushalmiYomiCalculator.java
@@ -20,7 +20,7 @@
 
 
 /**
- * This class calculates the <a href="https://en.wikipedia.org/wiki/Jerusalem_Talmud">Yerusalmi</a> <a href=
+ * This class calculates the <a href="https://en.wikipedia.org/wiki/Jerusalem_Talmud">Talmud Yerusalmi</a> <a href=
  * "https://en.wikipedia.org/wiki/Daf_Yomi">Daf Yomi</a> page ({@link Daf}) for the a given date.
  * 
  * @author &copy; elihaidv
@@ -32,8 +32,11 @@ public class YerushalmiYomiCalculator {
 	 * The start date of the first Daf Yomi Yerushalmi cycle of February 2, 1980 / 18 Teves, 5740.
 	 */
 	private final static Calendar DAF_YOMI_START_DAY = new GregorianCalendar(1980, Calendar.FEBRUARY, 2);
+	/** The number of milliseconds in a day. */
 	private final static int DAY_MILIS = 1000 * 60 * 60 * 24;
+	/** The number of pages in the Talmud Yerushalmi.*/
 	private final static int WHOLE_SHAS_DAFS = 1554;
+	/** The number of pages per <em>masechta</em> (tractate).*/
 	private final static int[] BLATT_PER_MASSECTA = { 
 			68, 37, 34, 44, 31, 59, 26, 33, 28, 20, 13, 92, 65, 71, 22, 22, 42, 26, 26, 33, 34, 22,
 			19, 85, 72, 47, 40, 47, 54, 48, 44, 37, 34, 44, 9, 57, 37, 19, 13};
diff --git a/src/main/java/com/kosherjava/zmanim/hebrewcalendar/YomiCalculator.java b/src/main/java/com/kosherjava/zmanim/hebrewcalendar/YomiCalculator.java
@@ -31,12 +31,17 @@ public class YomiCalculator {
 	 * The start date of the first Daf Yomi Bavli cycle of September 11, 1923 / Rosh Hashana 5684.
 	 */
 	private static final Calendar dafYomiStartDay = new GregorianCalendar(1923, Calendar.SEPTEMBER, 11);
+	/** The start date of the first Daf Yomi Bavli cycle in the Julian calendar. Used internally for claculations.*/
 	private static final int dafYomiJulianStartDay = getJulianDay(dafYomiStartDay);
 	/**
 	 * The date that the pagination for the Daf Yomi <em>Maseches Shekalim</em> 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 final Calendar shekalimChangeDay = new GregorianCalendar(1975, Calendar.JUNE, 24);
+	
+	/** The Julian date that the cycle for Shekalim changed.
+	 * @see #getDafYomiBavli(JewishCalendar) for details.
+	 */
 	private static final int shekalimJulianChangeDay = getJulianDay(shekalimChangeDay);
 
 	/**
diff --git a/src/main/java/com/kosherjava/zmanim/util/GeoLocation.java b/src/main/java/com/kosherjava/zmanim/util/GeoLocation.java
@@ -1,6 +1,6 @@
 /*
  * Zmanim Java API
- * Copyright (C) 2004-2018 Eliyahu Hershfeld
+ * Copyright (C) 2004-2020 Eliyahu Hershfeld
  *
  * This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General
  * Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option)
@@ -24,16 +24,56 @@
  * algorithm.
  * 
  * @author &copy; Eliyahu Hershfeld 2004 - 2020
- * @version 1.1
  */
 public class GeoLocation implements Cloneable {
+	/**
+	 * @see #getLatitude()
+	 * @see #setLatitude(double)
+	 * @see #setLatitude(int, int, double, String)
+	 */
 	private double latitude;
+	
+	/**
+	 * @see #getLongitude()
+	 * @see #setLongitude(double)
+	 * @see #setLongitude(int, int, double, String)
+	 */
 	private double longitude;
+	
+	/**
+	 * @see #getLocationName()
+	 * @see #setLocationName(String)
+	 */
 	private String locationName;
+	
+	/**
+	 * @see #getTimeZone()
+	 * @see #setTimeZone(TimeZone)
+	 */
 	private TimeZone timeZone;
+	
+	/**
+	 * @see #getElevation()
+	 * @see #setElevation(double)
+	 */
 	private double elevation;
+	
+	/**
+	 * Constant for a distance type calculation.
+	 * @see #getGeodesicDistance(GeoLocation)
+	 */
 	private static final int DISTANCE = 0;
+	
+	/**
+	 * Constant for a initial bearing type calculation.
+	 * @see #getGeodesicInitialBearing(GeoLocation)
+	 */
 	private static final int INITIAL_BEARING = 1;
+	
+	/**
+	 * Constant for a final bearing type calculation.
+	 * @see #getGeodesicFinalBearing(GeoLocation)
+	 */
 	private static final int FINAL_BEARING = 2;
 
 	/** constant for milliseconds in a minute (60,000) */
diff --git a/src/main/java/com/kosherjava/zmanim/util/GeoLocationUtils.java b/src/main/java/com/kosherjava/zmanim/util/GeoLocationUtils.java
@@ -1,6 +1,6 @@
 /*
  * Zmanim Java API
- * Copyright (C) 2004-2018 Eliyahu Hershfeld
+ * Copyright (C) 2004-2020 Eliyahu Hershfeld
  *
  * This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General
  * Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option)
@@ -21,10 +21,26 @@
  * <a href="http://www.fsf.org/licensing/licenses/lgpl.html">LGPL</a> Javascript Implementation
  *
  * @author &copy; Eliyahu Hershfeld 2009 - 2020
+ * @deprecated All methods in this call are available in the {@link GeoLocation} class, and this class that duplicates that
+ * code will be removed in release 3.0.
  */
 public class GeoLocationUtils {
+	/**
+	 * Constant for a distance type calculation.
+	 * @see #getGeodesicDistance(GeoLocation, GeoLocation)
+	 */
 	private static int DISTANCE = 0;
+	
+	/**
+	 * Constant for a initial bearing type calculation.
+	 * @see #getGeodesicInitialBearing(GeoLocation, GeoLocation)
+	 */
 	private static int INITIAL_BEARING = 1;
+	
+	/**
+	 * Constant for a final bearing type calculation.
+	 * @see #getGeodesicFinalBearing(GeoLocation, GeoLocation)
+	 */
 	private static int FINAL_BEARING = 2;
 
 	/**
diff --git a/src/main/java/com/kosherjava/zmanim/util/Time.java b/src/main/java/com/kosherjava/zmanim/util/Time.java
diff --git a/src/main/java/com/kosherjava/zmanim/util/ZmanimFormatter.java b/src/main/java/com/kosherjava/zmanim/util/ZmanimFormatter.java
