Reformat code comments for consistency and clarity across all classes

src/main/java/dev/coph/nextusweb/server/websocket/WebSocketSession.java

@@ -36,21 +36,35 @@ import java.util.concurrent.ConcurrentHashMap;
  */
 public final class WebSocketSession {
 
-    /** Channel attribute key under which the session is stored on its Netty channel. */
+    /**
+     * Channel attribute key under which the session is stored on its Netty channel.
+     */
     static final AttributeKey<WebSocketSession> SESSION_KEY =
             AttributeKey.valueOf("nexusweb.ws.session");
 
-    /** The underlying Netty channel for this connection. */
+    /**
+     * The underlying Netty channel for this connection.
+     */
     private final Channel channel;
-    /** Unique identifier generated for this session. */
+    /**
+     * Unique identifier generated for this session.
+     */
     private final String id;
-    /** The path the connection was established on. */
+    /**
+     * The path the connection was established on.
+     */
     private final String path;
-    /** Path parameters captured during routing, keyed by name. */
+    /**
+     * Path parameters captured during routing, keyed by name.
+     */
     private final Map<String, String> pathParams;
-    /** Authenticated principal for this connection, or {@code null} if anonymous. */
+    /**
+     * Authenticated principal for this connection, or {@code null} if anonymous.
+     */
     private final Principal principal;
-    /** Thread-safe bag of user-defined attributes attached to the session. */
+    /**
+     * Thread-safe bag of user-defined attributes attached to the session.
+     */
     private final Map<String, Object> attributes = new ConcurrentHashMap<>();
 
     /**
@@ -70,6 +84,36 @@ public final class WebSocketSession {
         this.principal = principal;
     }
 
+    /**
+     * Low-level helper that writes a text payload directly to a channel, allocating the buffer
+     * from the channel's allocator. Used by collaborators that hold a channel but not a session.
+     *
+     * @param channel the channel to write to
+     * @param text    the text to send
+     * @return a future completing when the write finishes; an already-succeeded future if the
+     * channel is no longer active
+     */
+    static ChannelFuture sendRaw(Channel channel, String text) {
+        if (!channel.isActive()) return channel.newSucceededFuture();
+        ByteBuf buf = channel.alloc().buffer();
+        buf.writeCharSequence(text, CharsetUtil.UTF_8);
+        return channel.writeAndFlush(new TextWebSocketFrame(true, 0, buf));
+    }
+
+    /**
+     * Low-level helper that writes a binary payload directly to a channel.
+     *
+     * @param channel the channel to write to
+     * @param data    the bytes to send
+     * @return a future completing when the write finishes; an already-succeeded future if the
+     * channel is no longer active
+     */
+    static ChannelFuture sendRawBinary(Channel channel, byte[] data) {
+        if (!channel.isActive()) return channel.newSucceededFuture();
+        ByteBuf buf = channel.alloc().buffer(data.length).writeBytes(Unpooled.wrappedBuffer(data));
+        return channel.writeAndFlush(new BinaryWebSocketFrame(buf));
+    }
+
     /**
      * Returns the unique identifier generated for this session.
      *
@@ -121,7 +165,7 @@ public final class WebSocketSession {
      * Returns the peer's remote IP address.
      *
      * @return the remote host address, or a string form of the address if it is not an
-     *         {@link InetSocketAddress}; {@code null} if unavailable
+     * {@link InetSocketAddress}; {@code null} if unavailable
      */
     public String remoteAddress() {
         SocketAddress addr = channel.remoteAddress();
@@ -171,7 +215,7 @@ public final class WebSocketSession {
      *
      * @param text the text to send
      * @return a future completing when the write finishes; an already-succeeded future if the
-     *         channel is no longer active
+     * channel is no longer active
      */
     public ChannelFuture send(String text) {
         if (!channel.isActive()) return channel.newSucceededFuture();
@@ -183,7 +227,7 @@ public final class WebSocketSession {
      *
      * @param value the object to serialize and send
      * @return a future completing when the write finishes; an already-succeeded future if the
-     *         channel is no longer active
+     * channel is no longer active
      * @throws RuntimeException if JSON serialization fails
      */
     public ChannelFuture sendJson(Object value) {
@@ -202,7 +246,7 @@ public final class WebSocketSession {
      *
      * @param data the bytes to send
      * @return a future completing when the write finishes; an already-succeeded future if the
-     *         channel is no longer active
+     * channel is no longer active
      */
     public ChannelFuture sendBinary(byte[] data) {
         if (!channel.isActive()) return channel.newSucceededFuture();
@@ -214,7 +258,7 @@ public final class WebSocketSession {
      * Sends a WebSocket ping frame to the peer (e.g. as a keep-alive).
      *
      * @return a future completing when the write finishes; an already-succeeded future if the
-     *         channel is no longer active
+     * channel is no longer active
      */
     public ChannelFuture ping() {
         if (!channel.isActive()) return channel.newSucceededFuture();
@@ -237,41 +281,11 @@ public final class WebSocketSession {
      * @param code   the WebSocket close status code
      * @param reason the human-readable close reason
      * @return a future completing when the close frame has been written; an already-succeeded
-     *         future if the channel is no longer active
+     * future if the channel is no longer active
      */
     public ChannelFuture close(int code, String reason) {
         if (!channel.isActive()) return channel.newSucceededFuture();
         return channel.writeAndFlush(new CloseWebSocketFrame(code, reason))
                 .addListener(ChannelFutureListener.CLOSE);
     }
-
-    /**
-     * Low-level helper that writes a text payload directly to a channel, allocating the buffer
-     * from the channel's allocator. Used by collaborators that hold a channel but not a session.
-     *
-     * @param channel the channel to write to
-     * @param text    the text to send
-     * @return a future completing when the write finishes; an already-succeeded future if the
-     *         channel is no longer active
-     */
-    static ChannelFuture sendRaw(Channel channel, String text) {
-        if (!channel.isActive()) return channel.newSucceededFuture();
-        ByteBuf buf = channel.alloc().buffer();
-        buf.writeCharSequence(text, CharsetUtil.UTF_8);
-        return channel.writeAndFlush(new TextWebSocketFrame(true, 0, buf));
-    }
-
-    /**
-     * Low-level helper that writes a binary payload directly to a channel.
-     *
-     * @param channel the channel to write to
-     * @param data    the bytes to send
-     * @return a future completing when the write finishes; an already-succeeded future if the
-     *         channel is no longer active
-     */
-    static ChannelFuture sendRawBinary(Channel channel, byte[] data) {
-        if (!channel.isActive()) return channel.newSucceededFuture();
-        ByteBuf buf = channel.alloc().buffer(data.length).writeBytes(Unpooled.wrappedBuffer(data));
-        return channel.writeAndFlush(new BinaryWebSocketFrame(buf));
-    }
 }