Add comments and indent chained method calls.

Author: arik-so

ci/LDKSwift/Sources/LDKSwift/batteries/ChannelManagerConstructor.swift

@@ -23,8 +23,12 @@ enum RouterUnavailableError: Error {
     case channelManagerInitializationMissingScorerOrNetworkGraph
 }
 
+/// Argument used when deserializing ChannelManager instances. If the user has previously already taken it upon themselves to deserialize the NetworkGraph, the `instance`
+/// case may be used. Otherwise, `serialized` may be passed to have the deserializer handle the NetworkGraph, too.
 public enum NetworkGraphArgument {
+    /// Use if you have a serialized NetworkGraph that should be deserialized.
     case serialized([UInt8])
+    /// Use if you have already deserialized a NetworkGraph and wish to pass that instance here.
     case instance(NetworkGraph)
 }
 

src/generation/base_type_generator.mts

@@ -45,7 +45,7 @@ export abstract class BaseTypeGenerator<Type extends RustType> {
 	generate(type: Type) {
 		const fileName = this.swiftTypeName(type) + '.swift';
 		const fileContents = this.generateFileContents(type)
-		.replaceAll('#{swift_class_name}', fileName);
+			.replaceAll('#{swift_class_name}', fileName);
 		this.persist(type, fileContents);
 	}
 
@@ -202,7 +202,7 @@ export abstract class BaseTypeGenerator<Type extends RustType> {
 		}
 
 		let instantiationContext = '"#{swift_class_name}::\\(#function):\\(#line)"';
-		if(semantics.isConstructor && containerType && this.isElidedType(containerType)){
+		if (semantics.isConstructor && containerType && this.isElidedType(containerType)) {
 			swiftMethodArguments.push('instantiationContext: String');
 			instantiationContext = 'instantiationContext';
 		}
@@ -1072,8 +1072,15 @@ export abstract class BaseTypeGenerator<Type extends RustType> {
 		}
 
 		return `
+					/// Set to false to suppress an individual type's deinit log statements.
+					/// Only applicable when log threshold is set to \`.Debug\`.
 					public static var enableDeinitLogging = true
+
+					/// Set to true to suspend the freeing of this type's associated Rust memory.
+					/// Should only ever be used for debugging purposes, and will likely be
+					/// deprecated soon.
 					public static var suspendFreedom = false
+
 					private static var instanceCounter: UInt = 0
 					internal let instanceNumber: UInt
 

src/generation/bindings_file_generator.mts

@@ -24,20 +24,20 @@ export default class BindingsFileGenerator extends BaseTypeGenerator<GlobalBindi
 			const swiftMethodName = this.swiftMethodName(currentMethod.method);
 			const methodCode = this.generateMethod(currentMethod.method);
 			const renamedMethodCode = methodCode
-			.replace(swiftMethodName, currentMethod.swiftName);
+				.replace(swiftMethodName, currentMethod.swiftName);
 			generatedMethods += Generator.reindentCode(renamedMethodCode, 4);
 		}
 
 		let generatedTupleTypeAliases = '';
 		let generatedTupleConverters = '';
-		let generatedTupleComparators = ''
+		let generatedTupleComparators = '';
 
 		for (const [rawSwiftTypeSignature, tupleSizes] of Object.entries(this.auxiliaryArtifacts.tuples)) {
 			for (const currentTupleSize of tupleSizes) {
 				const tupleTypeName = `${rawSwiftTypeSignature}Tuple${currentTupleSize}`;
 				generatedTupleTypeAliases += `
 					internal typealias ${tupleTypeName} = (${Array(currentTupleSize).fill(rawSwiftTypeSignature)
-				.join(', ')})
+					.join(', ')})
 				`;
 
 				let tupleResultComponents = [];
@@ -46,7 +46,7 @@ export default class BindingsFileGenerator extends BaseTypeGenerator<GlobalBindi
 				for (let i = 0; i < currentTupleSize; i++) {
 					tupleResultComponents.push(`array[${i}]`);
 					arrayResultComponents.push(`tuple.${i}`);
-					comparator.push(`tupleA.${i} == tupleB.${i}`)
+					comparator.push(`tupleA.${i} == tupleB.${i}`);
 				}
 
 				generatedTupleConverters += `