Documentation

Author: Keval

open-weather-wrapper/src/main/java/com/openweatherweapper/Unit.java

@@ -14,8 +14,28 @@
 
 @SuppressWarnings("WeakerAccess")
 public class Unit {
+    /**
+     * Matrix units.
+     * <p>
+     * <li>Temperature: Celsius</li>
+     * <li>Speed: meter/sec</li>
+     */
     public static final String MATRIX = "metric";
+
+    /**
+     * Standard international units.
+     * <p>
+     * <li>Temperature: Kelvin</li>
+     * <li>Speed: meter/sec</li>
+     */
     public static final String STANDARD = "";
+
+    /**
+     * Imperial units.
+     * <p>
+     * <li>Temperature: Fahrenheit</li>
+     * <li>Speed: miles/hour</li>
+     */
     public static final String IMPERIAL = "imperial";
 
 

open-weather-wrapper/src/main/java/com/openweatherweapper/models/CurrentWeather.java

@@ -130,10 +130,18 @@ public String getCityName() {
         return cityName;
     }
 
+    /**
+     * @return Rain information
+     * @see Rain
+     */
     public Rain getRainInfo() {
         return rainInfo;
     }
 
+    /**
+     * @return Snow information
+     * @see Snow
+     */
     public Snow getSnowInfo() {
         return snowInfo;
     }

open-weather-wrapper/src/main/java/com/openweatherweapper/models/MultipleCitiesWeathers.java

@@ -21,6 +21,9 @@ public class MultipleCitiesWeathers {
     @Expose
     private List<CurrentWeather> weatherInfos = new ArrayList<>();
 
+    /**
+     * @return list of {@link CurrentWeather} information for each city
+     */
     public List<CurrentWeather> getWeatherInfos() {
         return weatherInfos;
     }

open-weather-wrapper/src/main/java/com/openweatherweapper/models/WeatherForecast.java

@@ -25,13 +25,22 @@ public class WeatherForecast {
     @Expose
     private List<Forecast> forecast = null;
 
+    /**
+     * @return City information
+     * @see City
+     */
     public City getCity() {
         return city;
     }
+
     public Long getNoOfForecastResult() {
         return noOfForecastResult;
     }
 
+    /**
+     * @return List of weather forecast for timed interval.
+     * @see Forecast
+     */
     public List<Forecast> getForecast() {
         return forecast;
     }

open-weather-wrapper/src/main/java/com/openweatherweapper/models/params/City.java

@@ -22,22 +22,38 @@ public class City {
     @Expose
     private long population;
 
+    /**
+     * @return id of the city
+     */
     public Long getId() {
         return id;
     }
 
+    /**
+     * @return nam eof the city
+     */
     public String getName() {
         return name;
     }
 
+    /**
+     * @return Coordinates of the city
+     * @see Coord
+     */
     public Coord getCoord() {
         return coord;
     }
 
+    /**
+     * @return ISO 3166 country code.
+     */
     public String getCountry() {
         return country;
     }
 
+    /**
+     * @return Population of the city. If not available, value will be 0.
+     */
     public Long getPopulation() {
         return population;
     }

open-weather-wrapper/src/main/java/com/openweatherweapper/models/params/Coord.java

@@ -4,6 +4,9 @@
 import com.google.gson.annotations.Expose;
 import com.google.gson.annotations.SerializedName;
 
+/**
+ * Latitude and longitude coordinates for the geo point.
+ */
 public class Coord {
 
     @SerializedName("lon")

open-weather-wrapper/src/main/java/com/openweatherweapper/models/params/Forecast.java

@@ -32,29 +32,48 @@ public class Forecast {
     private Rain rain;
 
     /**
-     *
      * @return Time of data forecasted, unix, UTC
      */
     public Long getForecastTime() {
         return forecastTime;
     }
 
+    /**
+     * @return {@link Main}
+     * @see Main
+     */
     public Main getMain() {
         return main;
     }
 
-    public java.util.List<Weather> getWeather() {
+    /**
+     * @return Weather information
+     * @see Weather
+     */
+    public List<Weather> getWeather() {
         return weather;
     }
 
+    /**
+     * @return Get cloudiness information
+     * @see Clouds
+     */
     public Clouds getClouds() {
         return clouds;
     }
 
+    /**
+     * @return Wind information
+     * @see Wind
+     */
     public Wind getWind() {
         return wind;
     }
 
+    /**
+     * @return Rain information
+     * @see Rain
+     */
     public Rain getRain() {
         return rain;
     }