Skip to content

Commit 284c947

Browse files
committed
Some javadocs information
1 parent 2862eca commit 284c947

File tree

3 files changed

+9
-9
lines changed

3 files changed

+9
-9
lines changed

src/main/java/io/ipinfo/api/IPInfo.java

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ public static void main(String... args) {
3131
/**
3232
* Gets the builder for IPInfo
3333
*
34-
* @return
34+
* @return IPInfoBuilder object
3535
*/
3636
public static IPInfoBuilder builder() {
3737
return new IPInfoBuilder();
@@ -40,9 +40,9 @@ public static IPInfoBuilder builder() {
4040
/**
4141
* Lookup IP information using the IP.
4242
*
43-
* @param ip
44-
* @return IPResponse
45-
* @throws RateLimitedException
43+
* @param ip the ip string to lookup - accepts both ipv4 and ipv6.
44+
* @return IPResponse response from the api.
45+
* @throws RateLimitedException an exception when your api key has been rate limited.
4646
*/
4747
public IPResponse lookupIP(String ip) throws RateLimitedException {
4848
IPResponse response = cache.getIp(ip);
@@ -58,9 +58,9 @@ public IPResponse lookupIP(String ip) throws RateLimitedException {
5858
/**
5959
* Lookup ASN information using the AS number.
6060
*
61-
* @param asn
62-
* @return ASNResponse
63-
* @throws RateLimitedException
61+
* @param asn the asn string to lookup.
62+
* @return ASNResponse response from the api.
63+
* @throws RateLimitedException an exception when your api key has been rate limited.
6464
*/
6565
public ASNResponse lookupASN(String asn) throws RateLimitedException {
6666
ASNResponse response = cache.getAsn(asn);

src/main/java/io/ipinfo/api/model/ASNResponse.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ public ASNResponse(String asn, String name, String country, String allocated, St
3434
/**
3535
* Set by the library for extra utility functions
3636
*
37-
* @param context
37+
* @param context for country information
3838
*/
3939
public void setContext(Context context) {
4040
this.context = context;

src/main/java/io/ipinfo/api/model/IPResponse.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ public IPResponse(String ip, String hostname, String city, String region, String
3535
/**
3636
* Set by the library for extra utility functions
3737
*
38-
* @param context
38+
* @param context for country information
3939
*/
4040
public void setContext(Context context) {
4141
this.context = context;

0 commit comments

Comments
 (0)