Skip to content

Commit 32d70c8

Browse files
committed
Add javadoc checkstyle
1 parent 02bd1bd commit 32d70c8

File tree

3 files changed

+17
-0
lines changed

3 files changed

+17
-0
lines changed

checkstyle.xml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,5 +145,13 @@
145145
<module name="RedundantImport"/> <!-- e.g. double import statements: http://checkstyle.sourceforge.net/config_imports.html#RedundantImport -->
146146
<module name="UnusedImports"/> <!-- http://checkstyle.sourceforge.net/config_imports.html#UnusedImports -->
147147
<module name="IllegalImport"/> <!-- checks if import sun.* is used http://checkstyle.sourceforge.net/config_imports.html#IllegalImport -->
148+
149+
<!-- Javadoc -->
150+
<module name="JavadocType">
151+
<property name="scope" value="protected"/> <!-- means protected and public -->
152+
</module>
153+
<module name="JavadocMethod">
154+
<property name="scope" value="protected"/> <!-- means protected and public -->
155+
</module>
148156
</module>
149157
</module>

src/main/java/at/favre/lib/bytes/BytesTransformers.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,9 @@ public boolean supportInPlaceTransformation() {
171171
* Adds or converts to arbitrary checksum
172172
*/
173173
public static final class ChecksumTransformer implements BytesTransformer {
174+
/**
175+
* Definitions of the mode
176+
*/
174177
public enum Mode {
175178
/**
176179
* Appends checksum to given byte array

src/main/java/at/favre/lib/bytes/Util.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -454,6 +454,12 @@ static boolean equals(byte[] obj, Byte[] anotherArray) {
454454
limitations under the License.
455455
=================================================================================================
456456
*/
457+
458+
/**
459+
* Class that calculates the entropy factor
460+
*
461+
* @param <T>
462+
*/
457463
static final class Entropy<T> {
458464
private final Map<T, Integer> map = new HashMap<>();
459465
private int total = 0;

0 commit comments

Comments
 (0)