hexedtech/codemp
3
0
Fork 0
mirror of https://github.com/hexedtech/codemp.git synced 2024-11-21 14:54:49 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: added missing javadocs

Browse source
This commit is contained in:
zaaarf 2024-10-15 21:55:23 +02:00
parent b452cb822f
commit 2e583028a6
No known key found for this signature in database
GPG key ID: 102E445F4C3F829B
5 changed files with 12 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
dist/java/src/mp/code/BufferController.java vendored
View file

@ -70,6 +70,7 @@ public final class BufferController {
/**
* Tries to send a {@link TextChange} update.
* @param change the update to send
* @throws ControllerException if the controller was stopped
*/
public void send(TextChange change) throws ControllerException {
@ -81,6 +82,8 @@ public final class BufferController {
/**
* Registers a callback to be invoked whenever a {@link BufferUpdate} occurs.
* This will not work unless a Java thread has been dedicated to the event loop.
* @param cb a {@link Consumer} that receives the controller when the change occurs;
* you should probably spawn a new thread in here, to avoid deadlocking
* @see Extensions#drive(boolean)
*/
public void callback(Consumer<BufferController> cb) {

9
dist/java/src/mp/code/CursorController.java vendored
View file

@ -43,14 +43,15 @@ public final class CursorController {
return recv(this.ptr);
}
private static native void send(long self, Selection cursor) throws ControllerException;
private static native void send(long self, Selection selection) throws ControllerException;
/**
* Tries to send a {@link Selection} update.
* @param selection the update to send
* @throws ControllerException if the controller was stopped
*/
public void send(Selection cursor) throws ControllerException {
send(this.ptr, cursor);
public void send(Selection selection) throws ControllerException {
send(this.ptr, selection);
}
private static native void callback(long self, Consumer<CursorController> cb);
@ -58,6 +59,8 @@ public final class CursorController {
/**
* Registers a callback to be invoked whenever a {@link Cursor} update occurs.
* This will not work unless a Java thread has been dedicated to the event loop.
* @param cb a {@link Consumer} that receives the controller when the change occurs;
* you should probably spawn a new thread in here, to avoid deadlocking
* @see Extensions#drive(boolean)
*/
public void callback(Consumer<CursorController> cb) {

2
dist/java/src/mp/code/Extensions.java vendored
View file

@ -33,7 +33,7 @@ public final class Extensions {
* <p>
* You may alternatively call this with true, in a separate and dedicated Java thread;
* it will remain active in the background and act as event loop. Assign it like this:
* <p><code>new Thread(() -> Extensions.drive(true)).start();</code></p>
* <p><code>new Thread(() -&gt; Extensions.drive(true)).start();</code></p>
* @param block true if it should use the current thread
*/
public static native void drive(boolean block);

2
dist/java/src/mp/code/Workspace.java vendored
View file

@ -196,6 +196,8 @@ public final class Workspace {
/**
* Registers a callback to be invoked whenever a new {@link Event} is ready to be received.
* This will not work unless a Java thread has been dedicated to the event loop.
* @param cb a {@link Consumer} that receives the controller when the change occurs;
* you should probably spawn a new thread in here, to avoid deadlocking
* @see Extensions#drive(boolean)
*/
public void callback(Consumer<Workspace> cb) {

3
dist/java/src/mp/code/data/TextChange.java vendored
View file

@ -3,9 +3,6 @@ package mp.code.data;
import lombok.EqualsAndHashCode;
import lombok.RequiredArgsConstructor;
import lombok.ToString;
import mp.code.Extensions;
import java.util.OptionalLong;
/**
* A data class holding information about a text change.