X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Forg%2Fldk%2Fstructs%2FChannelFeatures.java;fp=src%2Fmain%2Fjava%2Forg%2Fldk%2Fstructs%2FChannelFeatures.java;h=bac024ad142aed562747554b8cd604d86d6aadd7;hb=17113550a5fefab21f39f27fbfe02646b8db53ae;hp=7b10e51bf73b03276b062101feda6a0961b21841;hpb=d69a40d071871d3c0e4160744202c6e85941a4cc;p=ldk-java

diff --git a/src/main/java/org/ldk/structs/ChannelFeatures.java b/src/main/java/org/ldk/structs/ChannelFeatures.java
index 7b10e51b..bac024ad 100644
--- a/src/main/java/org/ldk/structs/ChannelFeatures.java
+++ b/src/main/java/org/ldk/structs/ChannelFeatures.java
@@ -5,6 +5,10 @@ import org.ldk.enums.*;
 import org.ldk.util.*;
 import java.util.Arrays;
 
+
+/**
+ * Features used within a `channel_announcement` message.
+ */
 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
 public class ChannelFeatures extends CommonBase {
 	ChannelFeatures(Object _dummy, long ptr) { super(ptr); }
@@ -14,6 +18,9 @@ public class ChannelFeatures extends CommonBase {
 		if (ptr != 0) { bindings.ChannelFeatures_free(ptr); }
 	}
 
+	/**
+	 * Creates a copy of the ChannelFeatures
+	 */
 	public ChannelFeatures clone() {
 		long ret = bindings.ChannelFeatures_clone(this.ptr);
 		ChannelFeatures ret_hu_conv = new ChannelFeatures(null, ret);
@@ -21,6 +28,9 @@ public class ChannelFeatures extends CommonBase {
 		return ret_hu_conv;
 	}
 
+	/**
+	 * Create a blank Features with no features set
+	 */
 	public static ChannelFeatures constructor_empty() {
 		long ret = bindings.ChannelFeatures_empty();
 		ChannelFeatures ret_hu_conv = new ChannelFeatures(null, ret);
@@ -28,6 +38,11 @@ public class ChannelFeatures extends CommonBase {
 		return ret_hu_conv;
 	}
 
+	/**
+	 * Creates features known by the implementation as defined by [`T::KNOWN_FEATURE_FLAGS`].
+	 * 
+	 * [`T::KNOWN_FEATURE_FLAGS`]: sealed/trait.Context.html#associatedconstant.KNOWN_FEATURE_FLAGS
+	 */
 	public static ChannelFeatures constructor_known() {
 		long ret = bindings.ChannelFeatures_known();
 		ChannelFeatures ret_hu_conv = new ChannelFeatures(null, ret);
@@ -35,11 +50,17 @@ public class ChannelFeatures extends CommonBase {
 		return ret_hu_conv;
 	}
 
+	/**
+	 * Serialize the ChannelFeatures object into a byte array which can be read by ChannelFeatures_read
+	 */
 	public byte[] write() {
 		byte[] ret = bindings.ChannelFeatures_write(this.ptr);
 		return ret;
 	}
 
+	/**
+	 * Read a ChannelFeatures from a byte array, created by ChannelFeatures_write
+	 */
 	public static Result_ChannelFeaturesDecodeErrorZ constructor_read(byte[] ser) {
 		long ret = bindings.ChannelFeatures_read(ser);
 		Result_ChannelFeaturesDecodeErrorZ ret_hu_conv = Result_ChannelFeaturesDecodeErrorZ.constr_from_ptr(ret);