X-Git-Url: http://git.bitcoin.ninja/index.cgi?p=ldk-java;a=blobdiff_plain;f=ts%2Fstructs%2FEventHandler.mts;h=dbd405d85b9d8d9b7861be814b0eae80f459ad43;hp=83727493184eddbac2d0e4ff4de57cc0708611a7;hb=c629a01650402c8e2f9b9db8ced9ed63ce687727;hpb=d1d0121c000b713c10fd0bedd249eb8dda2e4db7

diff --git a/ts/structs/EventHandler.mts b/ts/structs/EventHandler.mts
index 83727493..dbd405d8 100644
--- a/ts/structs/EventHandler.mts
+++ b/ts/structs/EventHandler.mts
@@ -283,7 +283,12 @@ import * as bindings from '../bindings.mjs'
 
 
 
+/** An implementation of EventHandler */
 export interface EventHandlerInterface {
+	/**Handles the given [`Event`].
+	 * 
+	 * See [`EventsProvider`] for details that must be considered when implementing this method.
+	 */
 	handle_event(event: Event): void;
 }
 
@@ -291,6 +296,9 @@ class LDKEventHandlerHolder {
 	held: EventHandler;
 }
 
+/**
+ * A trait implemented for objects handling events from [`EventsProvider`].
+ */
 export class EventHandler extends CommonBase {
 	/* @internal */
 	public bindings_instance?: bindings.LDKEventHandler;
@@ -301,7 +309,8 @@ export class EventHandler extends CommonBase {
 		this.bindings_instance = null;
 	}
 
-	static new_impl(arg: EventHandlerInterface): EventHandler {
+	/** Creates a new instance of EventHandler from a given implementation */
+	public static new_impl(arg: EventHandlerInterface): EventHandler {
 		const impl_holder: LDKEventHandlerHolder = new LDKEventHandlerHolder();
 		let structImplementation = {
 			handle_event (event: number): void {
@@ -315,6 +324,12 @@ export class EventHandler extends CommonBase {
 		impl_holder.held.bindings_instance = structImplementation;
 		return impl_holder.held;
 	}
+
+	/**
+	 * Handles the given [`Event`].
+	 * 
+	 * See [`EventsProvider`] for details that must be considered when implementing this method.
+	 */
 	public handle_event(event: Event): void {
 		bindings.EventHandler_handle_event(this.ptr, event == null ? 0 : CommonBase.get_ptr_of(event) & ~1);
 	}