X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Forg%2Fldk%2Fstructs%2FPeerManager.java;h=ce9d3159666f94ec8724a73c8153c1af3df4fe8c;hb=4a36fa97d4eee96099c4a176ea845c52db27e64c;hp=392cba6b2feebdb76ea557051586d4a1bb11af7f;hpb=46763b974f120d1795fca6c1e757578784f3305a;p=ldk-java

diff --git a/src/main/java/org/ldk/structs/PeerManager.java b/src/main/java/org/ldk/structs/PeerManager.java
index 392cba6b..ce9d3159 100644
--- a/src/main/java/org/ldk/structs/PeerManager.java
+++ b/src/main/java/org/ldk/structs/PeerManager.java
@@ -21,10 +21,10 @@ import javax.annotation.Nullable;
  * [`PeerManager`] functions related to the same connection must occur only in serial, making new
  * calls only after previous ones have returned.
  * 
- * Rather than using a plain PeerManager, it is preferable to use either a SimpleArcPeerManager
- * a SimpleRefPeerManager, for conciseness. See their documentation for more details, but
- * essentially you should default to using a SimpleRefPeerManager, and use a
- * SimpleArcPeerManager when you require a PeerManager with a static lifetime, such as when
+ * Rather than using a plain [`PeerManager`], it is preferable to use either a [`SimpleArcPeerManager`]
+ * a [`SimpleRefPeerManager`], for conciseness. See their documentation for more details, but
+ * essentially you should default to using a [`SimpleRefPeerManager`], and use a
+ * [`SimpleArcPeerManager`] when you require a `PeerManager` with a static lifetime, such as when
  * you're using lightning-net-tokio.
  * 
  * [`read_event`]: PeerManager::read_event
@@ -39,8 +39,9 @@ public class PeerManager extends CommonBase {
 	}
 
 	/**
-	 * Constructs a new PeerManager with the given message handlers and node_id secret key
-	 * ephemeral_random_data is used to derive per-connection ephemeral keys and must be
+	 * Constructs a new `PeerManager` with the given message handlers.
+	 * 
+	 * `ephemeral_random_data` is used to derive per-connection ephemeral keys and must be
 	 * cryptographically secure random bytes.
 	 * 
 	 * `current_time` is used as an always-increasing counter that survives across restarts and is
@@ -109,9 +110,9 @@ public class PeerManager extends CommonBase {
 	 * Returns a small number of bytes to send to the remote node (currently always 50).
 	 * 
 	 * Panics if descriptor is duplicative with some other descriptor which has not yet been
-	 * [`socket_disconnected()`].
+	 * [`socket_disconnected`].
 	 * 
-	 * [`socket_disconnected()`]: PeerManager::socket_disconnected
+	 * [`socket_disconnected`]: PeerManager::socket_disconnected
 	 */
 	public Result_CVec_u8ZPeerHandleErrorZ new_outbound_connection(byte[] their_node_id, org.ldk.structs.SocketDescriptor descriptor, org.ldk.structs.Option_NetAddressZ remote_network_address) {
 		long ret = bindings.PeerManager_new_outbound_connection(this.ptr, InternalUtils.check_arr_len(their_node_id, 33), descriptor == null ? 0 : descriptor.ptr, remote_network_address.ptr);
@@ -139,9 +140,9 @@ public class PeerManager extends CommonBase {
 	 * the connection immediately.
 	 * 
 	 * Panics if descriptor is duplicative with some other descriptor which has not yet been
-	 * [`socket_disconnected()`].
+	 * [`socket_disconnected`].
 	 * 
-	 * [`socket_disconnected()`]: PeerManager::socket_disconnected
+	 * [`socket_disconnected`]: PeerManager::socket_disconnected
 	 */
 	public Result_NonePeerHandleErrorZ new_inbound_connection(org.ldk.structs.SocketDescriptor descriptor, org.ldk.structs.Option_NetAddressZ remote_network_address) {
 		long ret = bindings.PeerManager_new_inbound_connection(this.ptr, descriptor == null ? 0 : descriptor.ptr, remote_network_address.ptr);
@@ -163,7 +164,7 @@ public class PeerManager extends CommonBase {
 	 * May call [`send_data`] on the descriptor passed in (or an equal descriptor) before
 	 * returning. Thus, be very careful with reentrancy issues! The invariants around calling
 	 * [`write_buffer_space_avail`] in case a write did not fully complete must still hold - be
-	 * ready to call `[write_buffer_space_avail`] again if a write call generated here isn't
+	 * ready to call [`write_buffer_space_avail`] again if a write call generated here isn't
 	 * sufficient!
 	 * 
 	 * [`send_data`]: SocketDescriptor::send_data