From 6ec95a7f1310997d7c087decae52a188413f69a3 Mon Sep 17 00:00:00 2001
From: zzz <zzz@mail.i2p>
Date: Wed, 10 Jun 2020 15:28:22 +0000
Subject: [PATCH] Misc. Javadoc fixes
---
.../java/src/net/i2p/client/streaming/impl/Packet.java | 2 +-
core/java/src/net/i2p/crypto/EncAlgo.java | 2 --
core/java/src/net/i2p/crypto/EncType.java | 2 --
core/java/src/net/i2p/data/LeaseSet2.java | 2 +-
core/java/src/net/i2p/util/FileUtil.java | 1 +
router/java/src/net/i2p/router/crypto/ratchet/RatchetSKM.java | 2 +-
6 files changed, 4 insertions(+), 7 deletions(-)
diff --git a/apps/streaming/java/src/net/i2p/client/streaming/impl/Packet.java b/apps/streaming/java/src/net/i2p/client/streaming/impl/Packet.java
index 8872205d5c..eed07853d8 100644
--- a/apps/streaming/java/src/net/i2p/client/streaming/impl/Packet.java
+++ b/apps/streaming/java/src/net/i2p/client/streaming/impl/Packet.java
@@ -391,7 +391,7 @@ class Packet {
/**
* What is the largest payload the sender of this packet wants to receive?
*
- * @return Maximum payload size sender can receive (MRU)
+ * @return Maximum payload size sender can receive (MRU) or zero if unset
*/
public int getOptionalMaxSize() { return _optionMaxSize; }
diff --git a/core/java/src/net/i2p/crypto/EncAlgo.java b/core/java/src/net/i2p/crypto/EncAlgo.java
index 99a6c762e9..cc2c533820 100644
--- a/core/java/src/net/i2p/crypto/EncAlgo.java
+++ b/core/java/src/net/i2p/crypto/EncAlgo.java
@@ -1,8 +1,6 @@
package net.i2p.crypto;
/**
- * PRELIMINARY - unused - subject to change
- *
* Base encryption algorithm type
*
* @since 0.9.18
diff --git a/core/java/src/net/i2p/crypto/EncType.java b/core/java/src/net/i2p/crypto/EncType.java
index 368e620466..f05517ae08 100644
--- a/core/java/src/net/i2p/crypto/EncType.java
+++ b/core/java/src/net/i2p/crypto/EncType.java
@@ -11,8 +11,6 @@ import net.i2p.data.Hash;
import net.i2p.data.SimpleDataStructure;
/**
- * PRELIMINARY - subject to change
- *
* Defines the properties for various encryption types
* that I2P supports or may someday support.
*
diff --git a/core/java/src/net/i2p/data/LeaseSet2.java b/core/java/src/net/i2p/data/LeaseSet2.java
index 5a86f70234..7f7972fe85 100644
--- a/core/java/src/net/i2p/data/LeaseSet2.java
+++ b/core/java/src/net/i2p/data/LeaseSet2.java
@@ -21,7 +21,7 @@ import net.i2p.util.Log;
import net.i2p.util.OrderedProperties;
/**
- * PRELIMINARY - Subject to change - see proposal 123
+ * See proposal 123
*
* @since 0.9.38
*/
diff --git a/core/java/src/net/i2p/util/FileUtil.java b/core/java/src/net/i2p/util/FileUtil.java
index e1b6d0235f..d07c0f5bc2 100644
--- a/core/java/src/net/i2p/util/FileUtil.java
+++ b/core/java/src/net/i2p/util/FileUtil.java
@@ -361,6 +361,7 @@ public class FileUtil {
* Warning - this inefficiently allocates a StringBuilder of size maxNumLines*80,
* so don't make it too big.
* Warning - converts \r\n to \n
+ * Warning - inefficient if startAtBeginning is false, see console LogsHelper for better version
*
* @param startAtBeginning if true, read the first maxNumLines, otherwise read
* the last maxNumLines
diff --git a/router/java/src/net/i2p/router/crypto/ratchet/RatchetSKM.java b/router/java/src/net/i2p/router/crypto/ratchet/RatchetSKM.java
index 4746296403..aa0880b2ce 100644
--- a/router/java/src/net/i2p/router/crypto/ratchet/RatchetSKM.java
+++ b/router/java/src/net/i2p/router/crypto/ratchet/RatchetSKM.java
@@ -323,7 +323,7 @@ public class RatchetSKM extends SessionKeyManager implements SessionTagListener
/**
* Side effect - binds this session to the supplied destination.
*
- * @param the far-end Destination for this PublicKey if known, or null
+ * @param d the far-end Destination for this PublicKey if known, or null
* @return true if registered
* @since 0.9.47
*/
--
GitLab