Skip to content

Commit 11dc997

Browse files
committed
Require empty line before tags
1 parent 0dfdcd3 commit 11dc997

File tree

7 files changed

+16
-8
lines changed

7 files changed

+16
-8
lines changed

checkstyle.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -320,12 +320,12 @@
320320
value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>
321321
</module> -->
322322
<!-- <module name="JavadocParagraph"/>
323-
<module name="RequireEmptyLineBeforeBlockTagGroup"/>
324323
<module name="AtclauseOrder">
325324
<property name="tagOrder" value="@param, @return, @throws, @deprecated"/>
326325
<property name="target"
327326
value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
328327
</module> -->
328+
<module name="RequireEmptyLineBeforeBlockTagGroup"/>
329329
<module name="JavadocMethod">
330330
<property name="accessModifiers" value="public"/>
331331
<property name="allowMissingParamTags" value="true"/>

src/main/java/com/maxmind/db/CacheKey.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
* CacheKey is used as a key in the node cache. It contains the offset of the
55
* node in the database file, the class of the data at that node, and the type
66
* of the data at that node.
7-
*
7+
*
88
* @param <T> the type of data stored at the node
99
*/
1010
public final class CacheKey<T> {

src/main/java/com/maxmind/db/Metadata.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ public final class Metadata {
3232

3333
/**
3434
* Constructs a Metadata object.
35-
*
35+
*
3636
* @param binaryFormatMajorVersion The major version number for the database's
3737
* binary format.
3838
* @param binaryFormatMinorVersion The minor version number for the database's

src/main/java/com/maxmind/db/Network.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ public int getPrefixLength() {
6060
return prefixLength;
6161
}
6262

63-
/***
63+
/**
6464
* @return A string representation of the network in CIDR notation, e.g.,
6565
* <code>1.2.3.0/24</code> or <code>2001::/8</code>.
6666
*/

src/main/java/com/maxmind/db/Networks.java

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
/**
1212
* Instances of this class provide an iterator over the networks in a database.
1313
* The iterator will return a {@link DatabaseRecord} for each network.
14-
*
14+
*
1515
* @param <T> The type of data returned by the iterator.
1616
*/
1717
public final class Networks<T> implements Iterator<DatabaseRecord<T>> {
@@ -24,6 +24,7 @@ public final class Networks<T> implements Iterator<DatabaseRecord<T>> {
2424

2525
/**
2626
* Constructs a Networks instance.
27+
*
2728
* @param reader The reader object.
2829
* @param includeAliasedNetworks The boolean to include aliased networks.
2930
* @param typeParameterClass The type of data returned by the iterator.
@@ -36,6 +37,7 @@ public final class Networks<T> implements Iterator<DatabaseRecord<T>> {
3637

3738
/**
3839
* Constructs a Networks instance.
40+
*
3941
* @param reader The reader object.
4042
* @param includeAliasedNetworks The boolean to include aliased networks.
4143
* @param nodes The initial nodes array to start Networks iterator with.
@@ -60,6 +62,7 @@ public final class Networks<T> implements Iterator<DatabaseRecord<T>> {
6062

6163
/**
6264
* Constructs a Networks instance with includeAliasedNetworks set to false by default.
65+
*
6366
* @param reader The reader object.
6467
* @param typeParameterClass The type of data returned by the iterator.
6568
*/
@@ -69,6 +72,7 @@ public final class Networks<T> implements Iterator<DatabaseRecord<T>> {
6972

7073
/**
7174
* Returns the next DataRecord.
75+
*
7276
* @return The next DataRecord.
7377
* @throws NetworksIterationException An exception when iterating over the networks.
7478
*/
@@ -118,6 +122,7 @@ private boolean isInIpv4Subtree(byte[] ip) {
118122
* hasNext prepares the next network for reading with the Network method. It
119123
* returns true if there is another network to be processed and false if there
120124
* are no more networks.
125+
*
121126
* @return boolean True if there is another network to be processed.
122127
* @throws NetworksIterationException Exception while iterating over the networks.
123128
*/
@@ -169,6 +174,7 @@ static class NetworkNode {
169174

170175
/**
171176
* Constructs a network node for internal use.
177+
*
172178
* @param ip The ip address of the node.
173179
* @param prefix The prefix of the node.
174180
* @param pointer The node number

src/main/java/com/maxmind/db/NetworksIterationException.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
* This exception extends RuntimeException because it is thrown by the iterator
1010
* methods in {@link Networks}.
1111
* </p>
12-
*
12+
*
1313
* @see Networks
1414
*/
1515
public class NetworksIterationException extends RuntimeException {

src/main/java/com/maxmind/db/Reader.java

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ int record = traverseResult[0];
197197
* Please note that a MaxMind DB may map IPv4 networks into several locations
198198
* in an IPv6 database. networks() iterates over the canonical locations and
199199
* not the aliases. To include the aliases, you can set includeAliasedNetworks to true.
200-
*
200+
*
201201
* @param <T> Represents the data type(e.g., Map, HastMap, etc.).
202202
* @param typeParameterClass The type of data returned by the iterator.
203203
* @return Networks The Networks iterator.
@@ -216,7 +216,7 @@ public <T> Networks<T> networks(Class<T> typeParameterClass) throws
216216
* in an IPv6 database. This iterator will iterate over all of these locations
217217
* separately. To set the iteration over the IPv4 networks once, use the
218218
* includeAliasedNetworks option.
219-
*
219+
*
220220
* @param <T> Represents the data type(e.g., Map, HastMap, etc.).
221221
* @param includeAliasedNetworks Enable including aliased networks.
222222
* @return Networks The Networks iterator.
@@ -283,6 +283,7 @@ private int findIpV4StartNode(ByteBuffer buffer)
283283
* in an IPv6 database. This iterator will iterate over all of these locations
284284
* separately. To only iterate over the IPv4 networks once, use the
285285
* includeAliasedNetworks option.
286+
*
286287
* @param <T> Represents the data type(e.g., Map, HastMap, etc.).
287288
* @param network Specifies the network to be iterated.
288289
* @param includeAliasedNetworks Boolean for including aliased networks.
@@ -329,6 +330,7 @@ public <T> Networks<T> networksWithin(
329330

330331
/**
331332
* Returns the node number and the prefix for the network.
333+
*
332334
* @param ip The ip address to traverse.
333335
* @param bitCount The prefix.
334336
* @return int[]

0 commit comments

Comments
 (0)