Skip to content

Commit 18371ee

Browse files
oschwaldclaude
andcommitted
Fix additional Javadoc errors found in audit
- ConnectionTypeResponse.fromString() Javadoc said it creates a ConnectionTypeResponse; it returns the ConnectionType enum. - NetworkDeserializer constructor Javadoc had a malformed inline tag (@{code instead of {@code). - WebServiceProvider/WebServiceClient insights() @return said "Insight model" rather than "Insights model". - Corrected "a AnonymousIpResponse"/"a AnonymousPlusResponse" to "an ..." in DatabaseProvider and DatabaseReader Javadoc. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 4c6d19c commit 18371ee

6 files changed

Lines changed: 11 additions & 10 deletions

File tree

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

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Optional<CityResponse> tryCity(InetAddress ipAddress) throws IOException,
4242
* Look up an IP address in a GeoIP Anonymous IP.
4343
*
4444
* @param ipAddress IPv4 or IPv6 address to lookup.
45-
* @return a AnonymousIpResponse for the requested IP address.
45+
* @return an AnonymousIpResponse for the requested IP address.
4646
* @throws com.maxmind.geoip2.exception.GeoIp2Exception if there is an error looking up the IP
4747
* @throws java.io.IOException if there is an IO error
4848
*/
@@ -53,7 +53,7 @@ AnonymousIpResponse anonymousIp(InetAddress ipAddress) throws IOException,
5353
* Look up an IP address in a GeoIP Anonymous IP.
5454
*
5555
* @param ipAddress IPv4 or IPv6 address to lookup.
56-
* @return a AnonymousIpResponse for the requested IP address or empty if it is not in the DB.
56+
* @return an AnonymousIpResponse for the requested IP address or empty if it is not in the DB.
5757
* @throws com.maxmind.geoip2.exception.GeoIp2Exception if there is an error looking up the IP
5858
* @throws java.io.IOException if there is an IO error
5959
*/
@@ -64,7 +64,7 @@ Optional<AnonymousIpResponse> tryAnonymousIp(InetAddress ipAddress) throws IOExc
6464
* Look up an IP address in a GeoIP Anonymous Plus.
6565
*
6666
* @param ipAddress IPv4 or IPv6 address to lookup.
67-
* @return a AnonymousPlusResponse for the requested IP address.
67+
* @return an AnonymousPlusResponse for the requested IP address.
6868
* @throws com.maxmind.geoip2.exception.GeoIp2Exception if there is an error looking up the IP
6969
* @throws java.io.IOException if there is an IO error
7070
*/
@@ -75,7 +75,8 @@ AnonymousPlusResponse anonymousPlus(InetAddress ipAddress) throws IOException,
7575
* Look up an IP address in a GeoIP Anonymous Plus.
7676
*
7777
* @param ipAddress IPv4 or IPv6 address to lookup.
78-
* @return a AnonymousPlusResponse for the requested IP address or empty if it is not in the DB.
78+
* @return an AnonymousPlusResponse for the requested IP address or empty if it
79+
* is not in the DB.
7980
* @throws com.maxmind.geoip2.exception.GeoIp2Exception if there is an error looking up the IP
8081
* @throws java.io.IOException if there is an IO error
8182
*/

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -354,7 +354,7 @@ public Optional<CityResponse> tryCity(InetAddress ipAddress) throws IOException,
354354
* Look up an IP address in a GeoIP Anonymous IP.
355355
*
356356
* @param ipAddress IPv4 or IPv6 address to lookup.
357-
* @return a AnonymousIpResponse for the requested IP address.
357+
* @return an AnonymousIpResponse for the requested IP address.
358358
* @throws GeoIp2Exception if there is an error looking up the IP
359359
* @throws IOException if there is an IO error
360360
*/
@@ -381,7 +381,7 @@ public Optional<AnonymousIpResponse> tryAnonymousIp(InetAddress ipAddress) throw
381381
* Look up an IP address in a GeoIP Anonymous Plus.
382382
*
383383
* @param ipAddress IPv4 or IPv6 address to lookup.
384-
* @return a AnonymousPlusResponse for the requested IP address.
384+
* @return an AnonymousPlusResponse for the requested IP address.
385385
* @throws GeoIp2Exception if there is an error looking up the IP
386386
* @throws IOException if there is an IO error
387387
*/

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ public NetworkDeserializer() {
2121
}
2222

2323
/**
24-
* Constructs a @{code NetworkDeserializer} object.
24+
* Constructs a {@code NetworkDeserializer} object.
2525
*
2626
* @param vc a class
2727
*/

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -385,7 +385,7 @@ public InsightsResponse insights() throws IOException, GeoIp2Exception {
385385

386386
/**
387387
* @param ipAddress IPv4 or IPv6 address to lookup.
388-
* @return An Insight model for the requested IP address.
388+
* @return An Insights model for the requested IP address.
389389
* @throws GeoIp2Exception if there is an error looking up the IP
390390
* @throws IOException if there is an IO error
391391
*/

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ public interface WebServiceProvider extends GeoIp2Provider {
3434

3535
/**
3636
* @param ipAddress IPv4 or IPv6 address to lookup.
37-
* @return An Insight model for the requested IP address.
37+
* @return An Insights model for the requested IP address.
3838
* @throws GeoIp2Exception if there is an error looking up the IP
3939
* @throws IOException if there is an IO error
4040
*/

src/main/java/com/maxmind/geoip2/model/ConnectionTypeResponse.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ public String toString() {
6666
}
6767

6868
/**
69-
* Creates an instance of {@code ConnectionTypeResponse} from a string.
69+
* Creates an instance of {@code ConnectionType} from a string.
7070
*
7171
* @param s The string to create the instance from.
7272
*/

0 commit comments

Comments
 (0)