Fixed JavaDocs

Author: oschwald

src/main/java/com/maxmind/geoip2/DatabaseReader.java

@@ -55,7 +55,7 @@ public class DatabaseReader implements GeoIp2Provider, Closeable {
      * be a valid GeoIP2 database file.
      *
      * <code>Builder</code> creates instances of
-     * <code>DatabaseReader</client> from values set by the methods.
+     * <code>DatabaseReader</code> from values set by the methods.
      *
      * Only the values set in the <code>Builder</code> constructor are
      * required.

src/main/java/com/maxmind/geoip2/GeoIp2Provider.java

@@ -15,8 +15,8 @@ public interface GeoIp2Provider {
      * @param ipAddress
      *            IPv4 or IPv6 address to lookup.
      * @return A Country model for the requested IP address.
-     * @throws GeoIp2Exception
-     * @throws IOException
+     * @throws GeoIp2Exception if there is an error looking up the IP
+     * @throws IOException if there is an IO error
      */
     public CountryResponse country(InetAddress ipAddress) throws IOException,
             GeoIp2Exception;
@@ -25,8 +25,8 @@ public CountryResponse country(InetAddress ipAddress) throws IOException,
      * @param ipAddress
      *            IPv4 or IPv6 address to lookup.
      * @return A City model for the requested IP address.
-     * @throws GeoIp2Exception
-     * @throws IOException
+     * @throws GeoIp2Exception if there is an error looking up the IP
+     * @throws IOException if there is an IO error
      */
     public CityResponse city(InetAddress ipAddress) throws IOException,
             GeoIp2Exception;
@@ -35,8 +35,8 @@ public CityResponse city(InetAddress ipAddress) throws IOException,
      * @param ipAddress
      *            IPv4 or IPv6 address to lookup.
      * @return A CityIspOrg model for the requested IP address.
-     * @throws GeoIp2Exception
-     * @throws IOException
+     * @throws GeoIp2Exception if there is an error looking up the IP
+     * @throws IOException if there is an IO error
      */
     public CityIspOrgResponse cityIspOrg(InetAddress ipAddress)
             throws IOException, GeoIp2Exception;
@@ -45,8 +45,8 @@ public CityIspOrgResponse cityIspOrg(InetAddress ipAddress)
      * @param ipAddress
      *            IPv4 or IPv6 address to lookup.
      * @return An Omni model for the requested IP address.
-     * @throws GeoIp2Exception
-     * @throws IOException
+     * @throws GeoIp2Exception if there is an error looking up the IP
+     * @throws IOException if there is an IO error
      */
     public OmniResponse omni(InetAddress ipAddress) throws IOException,
             GeoIp2Exception;

src/main/java/com/maxmind/geoip2/WebServiceClient.java

@@ -119,7 +119,7 @@ public class WebServiceClient implements GeoIp2Provider {
 
     /**
      * <code>Builder</code> creates instances of
-     * <code>WebServiceClient</client> from values set by the methods.
+     * <code>WebServiceClient</code> from values set by the methods.
      *
      *  This example shows how to create a <code>WebServiceClient</code> object
      * with the <code>Builder</code>:
@@ -198,8 +198,8 @@ public WebServiceClient build() {
 
     /**
      * @return A Country model for the requesting IP address
-     * @throws GeoIp2Exception
-     * @throws IOException
+     * @throws GeoIp2Exception if there is an error from the web service
+     * @throws IOException if an IO error happens during the request
      */
     public CountryResponse country() throws IOException, GeoIp2Exception {
         return this.country(null);
@@ -213,8 +213,8 @@ public CountryResponse country(InetAddress ipAddress) throws IOException,
 
     /**
      * @return A City model for the requesting IP address
-     * @throws GeoIp2Exception
-     * @throws IOException
+     * @throws GeoIp2Exception if there is an error from the web service
+     * @throws IOException if an IO error happens during the request
      */
     public CityResponse city() throws IOException, GeoIp2Exception {
         return this.city(null);
@@ -228,8 +228,8 @@ public CityResponse city(InetAddress ipAddress) throws IOException,
 
     /**
      * @return A City/ISP/Org model for the requesting IP address
-     * @throws GeoIp2Exception
-     * @throws IOException
+     * @throws GeoIp2Exception if there is an error from the web service
+     * @throws IOException if an IO error happens during the request
      */
     public CityIspOrgResponse cityIspOrg() throws IOException, GeoIp2Exception {
         return this.cityIspOrg(null);
@@ -244,8 +244,8 @@ public CityIspOrgResponse cityIspOrg(InetAddress ipAddress)
 
     /**
      * @return An Omni model for the requesting IP address
-     * @throws GeoIp2Exception
-     * @throws IOException
+     * @throws GeoIp2Exception if there is an error from the web service
+     * @throws IOException if an IO error happens during the request
      */
     public OmniResponse omni() throws IOException, GeoIp2Exception {
         return this.omni(null);