Skip to content

Commit 7098484

Browse files
committed
More doc fixes
1 parent 51c2fd8 commit 7098484

File tree

3 files changed

+9
-4
lines changed

3 files changed

+9
-4
lines changed

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,7 @@ public Builder(File database) {
8989
* @param val
9090
* List of locale codes to use in name property from most
9191
* preferred to least preferred.
92+
* @return Builder object
9293
*/
9394
public Builder locales(List<String> val) {
9495
this.locales = val;
@@ -102,6 +103,7 @@ public Builder locales(List<String> val) {
102103
* if you initialized the Builder with a URL, which uses
103104
* {@link FileMode#MEMORY}, but you provided a different
104105
* FileMode to this method.
106+
* @return Builder object
105107
* */
106108
public Builder fileMode(FileMode val) {
107109
if (this.stream != null && !FileMode.MEMORY.equals(val)) {
@@ -115,7 +117,7 @@ public Builder fileMode(FileMode val) {
115117
/**
116118
* @return an instance of <code>DatabaseReader</code> created from the
117119
* fields set on this builder.
118-
* @throws IOException
120+
* @throws IOException if there is an error reading the database
119121
*/
120122
public DatabaseReader build() throws IOException {
121123
return new DatabaseReader(this);

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,7 @@ public Builder(int userId, String licenseKey) {
153153
/**
154154
* @param val
155155
* The host to use.
156+
* @return Builder object
156157
*/
157158
public Builder host(String val) {
158159
this.host = val;
@@ -163,6 +164,7 @@ public Builder host(String val) {
163164
* @param val
164165
* List of locale codes to use in name property from most
165166
* preferred to least preferred.
167+
* @return Builder object
166168
*/
167169
public Builder locales(List<String> val) {
168170
this.locales = val;
@@ -173,6 +175,7 @@ public Builder locales(List<String> val) {
173175
* @param val
174176
* Timeout in milliseconds for connection to web service. The
175177
* default is 3000 (3 seconds).
178+
* @return Builder object
176179
*/
177180
public Builder timeout(int val) {
178181
this.timeout = val;
@@ -181,6 +184,7 @@ public Builder timeout(int val) {
181184

182185
/**
183186
* @param val Transport for unit testing.
187+
* @return Builder object
184188
*/
185189
Builder testTransport(HttpTransport val) {
186190
this.testTransport = val;

src/main/java/com/maxmind/geoip2/record/Subdivision.java

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,8 @@ public Integer getConfidence() {
2929
/**
3030
* @return This is a string up to three characters long contain the
3131
* subdivision portion of the <a
32-
* href="http://en.wikipedia.org/wiki/ISO_3166-2 ISO 3166-2"
33-
* >code</a>. This attribute is returned by all end points except
34-
* Country.
32+
* href="http://en.wikipedia.org/wiki/ISO_3166-2">ISO 3166-2code</a>.
33+
* This attribute is returned by all end points except Country.
3534
*/
3635
public String getIsoCode() {
3736
return this.isoCode;

0 commit comments

Comments
 (0)