search

OpenHFT / Chronicle-Salt

Chronicle wrapper for the NaCl library
Apache License 2.0
30 stars 18 forks source link

Fix Javadoc warnings #16

Closed minborg closed 3 years ago

minborg commented 3 years ago

I've cleared numerous JavaDoc warnings. The following warnings remain to be fixed:

[WARNING] Javadoc Warnings
[WARNING] /Users/pemi/git/chronicle/opensource/Chronicle-Salt/src/main/java/net/openhft/chronicle/salt/EasyBox.java:257: warning: no @return
[WARNING] public static BytesStore decryptShared(@Nullable BytesStore result, @NotNull BytesStore ciphertext, BytesStore nonce, BytesStore sharedKey) {
[WARNING] ^
[WARNING] /Users/pemi/git/chronicle/opensource/Chronicle-Salt/src/main/java/net/openhft/chronicle/salt/EasyBox.java:304: warning: no @return
[WARNING] public static Nonce generate() {
[WARNING] ^
[WARNING] /Users/pemi/git/chronicle/opensource/Chronicle-Salt/src/main/java/net/openhft/chronicle/salt/EasyBox.java:319: warning: no @return
[WARNING] public static Nonce deterministic(long id) {
[WARNING] ^
[WARNING] /Users/pemi/git/chronicle/opensource/Chronicle-Salt/src/main/java/net/openhft/chronicle/salt/EasyBox.java:334: warning: no @return
[WARNING] public static Nonce deterministic(BytesStore seed) {
[WARNING] ^
[WARNING] /Users/pemi/git/chronicle/opensource/Chronicle-Salt/src/main/java/net/openhft/chronicle/salt/SealedBox.java:35: warning: no @param for message
[WARNING] public static BytesStore encrypt(@Nullable BytesStore result, @NotNull BytesStore message, @NotNull PublicKey publicKey) {
[WARNING] ^
[WARNING] /Users/pemi/git/chronicle/opensource/Chronicle-Salt/src/main/java/net/openhft/chronicle/salt/SealedBox.java:35: warning: no @param for publicKey
[WARNING] public static BytesStore encrypt(@Nullable BytesStore result, @NotNull BytesStore message, @NotNull PublicKey publicKey) {
[WARNING] ^
[WARNING] /Users/pemi/git/chronicle/opensource/Chronicle-Salt/src/main/java/net/openhft/chronicle/salt/SealedBox.java:43: warning: no @param for result
[WARNING] public static BytesStore encrypt(@Nullable BytesStore result, @NotNull BytesStore message, @NotNull BytesStore publicKey) {
[WARNING] ^
[WARNING] /Users/pemi/git/chronicle/opensource/Chronicle-Salt/src/main/java/net/openhft/chronicle/salt/SealedBox.java:43: warning: no @param for message
[WARNING] public static BytesStore encrypt(@Nullable BytesStore result, @NotNull BytesStore message, @NotNull BytesStore publicKey) {
[WARNING] ^
[WARNING] /Users/pemi/git/chronicle/opensource/Chronicle-Salt/src/main/java/net/openhft/chronicle/salt/SealedBox.java:43: warning: no @param for publicKey
[WARNING] public static BytesStore encrypt(@Nullable BytesStore result, @NotNull BytesStore message, @NotNull BytesStore publicKey) {
[WARNING] ^
[WARNING] /Users/pemi/git/chronicle/opensource/Chronicle-Salt/src/main/java/net/openhft/chronicle/salt/SealedBox.java:43: warning: no @return
[WARNING] public static BytesStore encrypt(@Nullable BytesStore result, @NotNull BytesStore message, @NotNull BytesStore publicKey) {
[WARNING] ^
[WARNING] /Users/pemi/git/chronicle/opensource/Chronicle-Salt/src/main/java/net/openhft/chronicle/salt/SealedBox.java:80: warning: no @param for ciphertext
[WARNING] public static BytesStore decrypt(@Nullable BytesStore result, @NotNull BytesStore ciphertext, @NotNull PublicKey publicKey,
[WARNING] ^
[WARNING] /Users/pemi/git/chronicle/opensource/Chronicle-Salt/src/main/java/net/openhft/chronicle/salt/SealedBox.java:80: warning: no @param for publicKey
[WARNING] public static BytesStore decrypt(@Nullable BytesStore result, @NotNull BytesStore ciphertext, @NotNull PublicKey publicKey,
[WARNING] ^
[WARNING] /Users/pemi/git/chronicle/opensource/Chronicle-Salt/src/main/java/net/openhft/chronicle/salt/SealedBox.java:80: warning: no @param for secretKey
[WARNING] public static BytesStore decrypt(@Nullable BytesStore result, @NotNull BytesStore ciphertext, @NotNull PublicKey publicKey,
[WARNING] ^
[WARNING] /Users/pemi/git/chronicle/opensource/Chronicle-Salt/src/main/java/net/openhft/chronicle/salt/SealedBox.java:89: warning: no @param for result
[WARNING] public static BytesStore decrypt(@Nullable BytesStore result, @NotNull BytesStore ciphertext, @NotNull BytesStore publicKey,
[WARNING] ^
[WARNING] /Users/pemi/git/chronicle/opensource/Chronicle-Salt/src/main/java/net/openhft/chronicle/salt/SealedBox.java:89: warning: no @param for ciphertext
[WARNING] public static BytesStore decrypt(@Nullable BytesStore result, @NotNull BytesStore ciphertext, @NotNull BytesStore publicKey,
[WARNING] ^
[WARNING] /Users/pemi/git/chronicle/opensource/Chronicle-Salt/src/main/java/net/openhft/chronicle/salt/SealedBox.java:89: warning: no @param for publicKey
[WARNING] public static BytesStore decrypt(@Nullable BytesStore result, @NotNull BytesStore ciphertext, @NotNull BytesStore publicKey,
[WARNING] ^
[WARNING] /Users/pemi/git/chronicle/opensource/Chronicle-Salt/src/main/java/net/openhft/chronicle/salt/SealedBox.java:89: warning: no @param for secretKey
[WARNING] public static BytesStore decrypt(@Nullable BytesStore result, @NotNull BytesStore ciphertext, @NotNull BytesStore publicKey,
[WARNING] ^
[WARNING] /Users/pemi/git/chronicle/opensource/Chronicle-Salt/src/main/java/net/openhft/chronicle/salt/SealedBox.java:89: warning: no @return
[WARNING] public static BytesStore decrypt(@Nullable BytesStore result, @NotNull BytesStore ciphertext, @NotNull BytesStore publicKey,
[WARNING] ^
[WARNING] /Users/pemi/git/chronicle/opensource/Chronicle-Salt/src/main/java/net/openhft/chronicle/salt/SealedBox.java:166: warning: no @return
[WARNING] public static KeyPair generate() {
[WARNING] ^
[WARNING] /Users/pemi/git/chronicle/opensource/Chronicle-Salt/src/main/java/net/openhft/chronicle/salt/Signature.java:33: warning: no @param for message
[WARNING] public static BytesStore sign(BytesStore result, BytesStore message, SecretKey secretKey) {
[WARNING] ^
[WARNING] /Users/pemi/git/chronicle/opensource/Chronicle-Salt/src/main/java/net/openhft/chronicle/salt/Signature.java:33: warning: no @param for secretKey
[WARNING] public static BytesStore sign(BytesStore result, BytesStore message, SecretKey secretKey) {
[WARNING] ^
[WARNING] /Users/pemi/git/chronicle/opensource/Chronicle-Salt/src/main/java/net/openhft/chronicle/salt/Signature.java:40: warning: no @param for result
[WARNING] public static BytesStore sign(BytesStore result, BytesStore message, BytesStore secretKey) {
[WARNING] ^
[WARNING] /Users/pemi/git/chronicle/opensource/Chronicle-Salt/src/main/java/net/openhft/chronicle/salt/Signature.java:40: warning: no @param for message
[WARNING] public static BytesStore sign(BytesStore result, BytesStore message, BytesStore secretKey) {
[WARNING] ^
[WARNING] /Users/pemi/git/chronicle/opensource/Chronicle-Salt/src/main/java/net/openhft/chronicle/salt/Signature.java:40: warning: no @param for secretKey
[WARNING] public static BytesStore sign(BytesStore result, BytesStore message, BytesStore secretKey) {
[WARNING] ^
[WARNING] /Users/pemi/git/chronicle/opensource/Chronicle-Salt/src/main/java/net/openhft/chronicle/salt/Signature.java:40: warning: no @return
[WARNING] public static BytesStore sign(BytesStore result, BytesStore message, BytesStore secretKey) {
[WARNING] ^
[WARNING] /Users/pemi/git/chronicle/opensource/Chronicle-Salt/src/main/java/net/openhft/chronicle/salt/Signature.java:75: warning: no @param for message
[WARNING] public static BytesStore verify(@Nullable BytesStore result, @NotNull BytesStore message, PublicKey publicKey) {
[WARNING] ^
[WARNING] /Users/pemi/git/chronicle/opensource/Chronicle-Salt/src/main/java/net/openhft/chronicle/salt/Signature.java:75: warning: no @param for publicKey
[WARNING] public static BytesStore verify(@Nullable BytesStore result, @NotNull BytesStore message, PublicKey publicKey) {
[WARNING] ^
[WARNING] /Users/pemi/git/chronicle/opensource/Chronicle-Salt/src/main/java/net/openhft/chronicle/salt/Signature.java:82: warning: no @param for result
[WARNING] public static BytesStore verify(@Nullable BytesStore result, @NotNull BytesStore message, BytesStore publicKey) {
[WARNING] ^
[WARNING] /Users/pemi/git/chronicle/opensource/Chronicle-Salt/src/main/java/net/openhft/chronicle/salt/Signature.java:82: warning: no @param for message
[WARNING] public static BytesStore verify(@Nullable BytesStore result, @NotNull BytesStore message, BytesStore publicKey) {
[WARNING] ^
[WARNING] /Users/pemi/git/chronicle/opensource/Chronicle-Salt/src/main/java/net/openhft/chronicle/salt/Signature.java:82: warning: no @param for publicKey
[WARNING] public static BytesStore verify(@Nullable BytesStore result, @NotNull BytesStore message, BytesStore publicKey) {
[WARNING] ^
[WARNING] /Users/pemi/git/chronicle/opensource/Chronicle-Salt/src/main/java/net/openhft/chronicle/salt/Signature.java:82: warning: no @return
[WARNING] public static BytesStore verify(@Nullable BytesStore result, @NotNull BytesStore message, BytesStore publicKey) {
[WARNING] ^
[WARNING] /Users/pemi/git/chronicle/opensource/Chronicle-Salt/src/main/java/net/openhft/chronicle/salt/Signature.java:191: warning: no @return
[WARNING] public static KeyPair generate() {
[WARNING] ^
[WARNING] /Users/pemi/git/chronicle/opensource/Chronicle-Salt/src/main/java/net/openhft/chronicle/salt/Signature.java:201: warning: no @return
[WARNING] public static KeyPair deterministic(long id) {
[WARNING] ^
[WARNING] /Users/pemi/git/chronicle/opensource/Chronicle-Salt/src/main/java/net/openhft/chronicle/salt/Signature.java:213: warning: no @return
[WARNING] public static KeyPair deterministic(BytesStore seed) {
[WARNING] ^