Skip to content

Commit

Permalink
fix typos
Browse files Browse the repository at this point in the history
  • Loading branch information
Ely committed Jan 11, 2024
1 parent 93f441f commit 1cee31f
Show file tree
Hide file tree
Showing 20 changed files with 266 additions and 272 deletions.
34 changes: 17 additions & 17 deletions src/main/java/com/kosherjava/zmanim/AstronomicalCalendar.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
* <code>{@link java.util.Date}</code> is expected and {@link Long#MIN_VALUE} when a <code>long</code> is expected. The
* reason that <code>Exception</code>s are not thrown in these cases is because the lack of a rise/set or twilight is
* not an exception, but an expected condition in many parts of the world.
*
* <p>
* Here is a simple example of how to use the API to calculate sunrise.
* First create the Calendar for the location you would like to calculate sunrise or sunset times for:
*
Expand Down Expand Up @@ -107,12 +107,12 @@ public class AstronomicalCalendar implements Cloneable {
private AstronomicalCalculator astronomicalCalculator;

/**
* The getSunrise method Returns a <code>Date</code> representing the
* The getSunrise method returns a <code>Date</code> representing the
* {@link AstronomicalCalculator#getElevationAdjustment(double) elevation adjusted} sunrise time. The zenith used
* for the calculation uses {@link #GEOMETRIC_ZENITH geometric zenith} of 90&deg; plus
* {@link AstronomicalCalculator#getElevationAdjustment(double)}. This is adjusted by the
* {@link AstronomicalCalculator} to add approximately 50/60 of a degree to account for 34 archminutes of refraction
* and 16 archminutes for the sun's radius for a total of {@link AstronomicalCalculator#adjustZenith 90.83333&deg;}.
* {@link AstronomicalCalculator} to add approximately 50/60 of a degree to account for 34 arch minutes of refraction
* and 16 arch minutes for the sun's radius for a total of {@link AstronomicalCalculator#adjustZenith 90.83333&deg;}.
* See documentation for the specific implementation of the {@link AstronomicalCalculator} that you are using.
*
* @return the <code>Date</code> representing the exact sunrise time. If the calculation can't be computed such as
Expand Down Expand Up @@ -192,12 +192,12 @@ public Date getBeginAstronomicalTwilight() {
}

/**
* The getSunset method Returns a <code>Date</code> representing the
* The getSunset method returns a <code>Date</code> representing the
* {@link AstronomicalCalculator#getElevationAdjustment(double) elevation adjusted} sunset time. The zenith used for
* the calculation uses {@link #GEOMETRIC_ZENITH geometric zenith} of 90&deg; plus
* {@link AstronomicalCalculator#getElevationAdjustment(double)}. This is adjusted by the
* {@link AstronomicalCalculator} to add approximately 50/60 of a degree to account for 34 archminutes of refraction
* and 16 archminutes for the sun's radius for a total of {@link AstronomicalCalculator#adjustZenith 90.83333&deg;}.
* {@link AstronomicalCalculator} to add approximately 50/60 of a degree to account for 34 arch minutes of refraction
* and 16 arch minutes for the sun's radius for a total of {@link AstronomicalCalculator#adjustZenith 90.83333&deg;}.
* See documentation for the specific implementation of the {@link AstronomicalCalculator} that you are using. Note:
* In certain cases the calculates sunset will occur before sunrise. This will typically happen when a timezone
* other than the local timezone is used (calculating Los Angeles sunset using a GMT timezone for example). In this
Expand Down Expand Up @@ -367,8 +367,8 @@ public AstronomicalCalendar() {
/**
* A constructor that takes in <a href="https://en.wikipedia.org/wiki/Geolocation">geolocation</a> information as a
* parameter. The default {@link AstronomicalCalculator#getDefault() AstronomicalCalculator} used for solar
* calculations is the the {@link com.kosherjava.zmanim.util.NOAACalculator}.
*
* calculations is the more accurate {@link com.kosherjava.zmanim.util.NOAACalculator}.
*
* @param geoLocation
* The location information used for calculating astronomical sun times.
*
Expand Down Expand Up @@ -470,7 +470,7 @@ public long getTemporalHour() {
* non-elevation adjusted temporal hour by passing in {@link #getSeaLevelSunrise() sea level sunrise} and
* {@link #getSeaLevelSunset() sea level sunset} as parameters.
*
* @param startOfday
* @param startOfDay
* The start of the day.
* @param endOfDay
* The end of the day.
Expand All @@ -480,11 +480,11 @@ public long getTemporalHour() {
*
* @see #getTemporalHour()
*/
public long getTemporalHour(Date startOfday, Date endOfDay) {
if (startOfday == null || endOfDay == null) {
public long getTemporalHour(Date startOfDay, Date endOfDay) {
if (startOfDay == null || endOfDay == null) {
return Long.MIN_VALUE;
}
return (endOfDay.getTime() - startOfday.getTime()) / 12;
return (endOfDay.getTime() - startOfDay.getTime()) / 12;
}

/**
Expand Down Expand Up @@ -562,8 +562,8 @@ public Date getSunTransit(Date startOfDay, Date endOfDay) {
* @param time
* The time to be set as the time for the <code>Date</code>. The time expected is in the format: 18.75
* for 6:45:00 PM.time is sunrise and false if it is sunset
* @param isSunrise true if the
* @return The Date.
* @param isSunrise true if this time is for sunrise
* @return The Date object representation of the time double
*/
protected Date getDateFromTime(double time, boolean isSunrise) {
if (Double.isNaN(time)) {
Expand Down Expand Up @@ -685,7 +685,7 @@ public Date getLocalMeanTime(double hours) {
}

/**
* Adjusts the <code>Calendar</code> to deal with edge cases where the location crosses the antimeridian.
* Adjusts the <code>Calendar</code> to deal with edge cases where the location crosses the anti meridian.
*
* @see GeoLocation#getAntimeridianAdjustment()
* @return the adjusted Calendar
Expand Down Expand Up @@ -786,7 +786,7 @@ public AstronomicalCalculator getAstronomicalCalculator() {
* different algorithms, including the default {@link com.kosherjava.zmanim.util.NOAACalculator} based on <a href=
* "https://noaa.gov">NOAA's</a> implementation of Jean Meeus's algorithms as well as {@link
* com.kosherjava.zmanim.util.SunTimesCalculator} based on the <a href = "https://www.cnmoc.usff.navy.mil/usno/">US
* Naval Observatory's</a> algorithm,. This allows easy runtime switching and comparison of different algorithms.
* Naval Observatory's</a> algorithm. This allows easy runtime switching and comparison of different algorithms.
*
* @param astronomicalCalculator
* The astronomicalCalculator to set.
Expand Down
Loading

0 comments on commit 1cee31f

Please sign in to comment.