Better readable javadoc for id generators

arteam · Jan 14, 2022 · 7d57ca6 · 7d57ca6
1 parent 86192fb
commit 7d57ca6
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 4 deletions.
diff --git a/...src/main/java/com/github/arteam/simplejsonrpc/client/generator/AtomicLongIdGenerator.java b/...src/main/java/com/github/arteam/simplejsonrpc/client/generator/AtomicLongIdGenerator.java
@@ -5,8 +5,9 @@
 /**
  * Date: 12/30/14
  * Time: 11:19 PM
- * <p>Return id from an atomic long counter
- * It's the most reliable and straightforward way to generate identifiers</p>
+ * <p>
+ * Return id from an atomic long counter.
+ * It's the most reliable and straightforward way to generate identifiers
  */
 public class AtomicLongIdGenerator implements IdGenerator<Long> {
 

diff --git a/...rc/main/java/com/github/arteam/simplejsonrpc/client/generator/CurrentTimeIdGenerator.java b/...rc/main/java/com/github/arteam/simplejsonrpc/client/generator/CurrentTimeIdGenerator.java
@@ -3,7 +3,8 @@
 /**
  * Date: 24.08.14
  * Time: 18:20
- * Return current time as id.
+ * <p>
+ * Return the current time as an id.
  * Not reliable if you need to guarantee uniqueness of request ids
  */
 public class CurrentTimeIdGenerator implements IdGenerator<Long> {

diff --git a/...c/main/java/com/github/arteam/simplejsonrpc/client/generator/SecureRandomIdGenerator.java b/...c/main/java/com/github/arteam/simplejsonrpc/client/generator/SecureRandomIdGenerator.java
@@ -5,6 +5,7 @@
 /**
  * Date: 1/12/15
  * Time: 11:17 PM
+ * <p>
  * Abstract generator of secure random identifiers
  */
 abstract class SecureRandomIdGenerator<T> implements IdGenerator<T> {

diff --git a/...ain/java/com/github/arteam/simplejsonrpc/client/generator/SecureRandomIntIdGenerator.java b/...ain/java/com/github/arteam/simplejsonrpc/client/generator/SecureRandomIntIdGenerator.java
@@ -3,8 +3,9 @@
 /**
  * Date: 1/12/15
  * Time: 11:38 PM
+ * <p>
  * Generates secure random positive integers under limit
- * By default limit is 65536
+ * By default the limit is 65536
  */
 public class SecureRandomIntIdGenerator extends SecureRandomIdGenerator<Integer> {
 

diff --git a/...in/java/com/github/arteam/simplejsonrpc/client/generator/SecureRandomLongIdGenerator.java b/...in/java/com/github/arteam/simplejsonrpc/client/generator/SecureRandomLongIdGenerator.java
@@ -3,6 +3,7 @@
 /**
  * Date: 1/12/15
  * Time: 11:12 PM
+ * <p>
  * Generate secure random positive long identifiers
  */
 public class SecureRandomLongIdGenerator extends SecureRandomIdGenerator<Long> {

diff --git a/.../java/com/github/arteam/simplejsonrpc/client/generator/SecureRandomStringIdGenerator.java b/.../java/com/github/arteam/simplejsonrpc/client/generator/SecureRandomStringIdGenerator.java
@@ -3,6 +3,7 @@
 /**
  * Date: 12/30/14
  * Time: 11:45 PM
+ * <p>
  * Generate secure random strings consisting of HEX symbols with length of 40 characters
  */
 public class SecureRandomStringIdGenerator extends SecureRandomIdGenerator<String> {