fix a number of spelling/grammar issues

pschichtel · pschichtel · commit e39d1861e370 · 2025-04-19T20:35:10.000+02:00
diff --git a/core/src/main/java/tel/schich/javacan/AbstractCanChannel.java b/core/src/main/java/tel/schich/javacan/AbstractCanChannel.java
@@ -224,7 +224,7 @@ protected long readSocket(ByteBuffer buffer) throws IOException {
      * @see <a href="https://man7.org/linux/man-pages/man2/recv.2.html">recv man page</a>
      * @param buffer the buffer to receive into
      * @param flags flags to pass to the underlying recv syscall
-     * @return The number of bytes receive from the socket
+     * @return The number of bytes received from the socket
      * @throws IOException if the native call fails
      */
     protected long receiveFromSocket(ByteBuffer buffer, int flags) throws IOException {
diff --git a/core/src/main/java/tel/schich/javacan/BcmCanChannel.java b/core/src/main/java/tel/schich/javacan/BcmCanChannel.java
@@ -50,6 +50,7 @@ public class BcmCanChannel extends AbstractCanChannel {
      * the buffer is large enough (~ 18 kB) for all use cases.
      */
     public static final int MTU = BcmMessage.HEADER_LENGTH + MAX_FRAMES_PER_MESSAGE * RawCanChannel.FD_MTU;
+
     @Nullable
     private NetworkDevice device;
 
diff --git a/core/src/main/java/tel/schich/javacan/BcmFlag.java b/core/src/main/java/tel/schich/javacan/BcmFlag.java
@@ -27,7 +27,7 @@
 
 /**
  * The BcmFlag enum represent the Broadcast Manager message flags. When sending a message to the
- * broadcast manager the ‘flags’ element influence the behavior.
+ * broadcast manager, the ‘flags’ element influences the behavior.
  *
  * @see <a href="https://www.kernel.org/doc/html/latest/networking/can.html#broadcast-manager-message-flags">
  *     Kernel CAN documentation: BCM message flags</a>
diff --git a/core/src/main/java/tel/schich/javacan/BcmMessage.java b/core/src/main/java/tel/schich/javacan/BcmMessage.java
@@ -46,7 +46,7 @@
  */
 public class BcmMessage {
     /**
-     * The platform dependent byte count for {@code struct bcm_msg_head} from {@code linux/can/bcm.h}
+     * The platform-dependent byte count for {@code struct bcm_msg_head} from {@code linux/can/bcm.h}
      */
     public static final int HEADER_LENGTH;
     /**
@@ -110,7 +110,7 @@ public class BcmMessage {
 
     /**
      * Create a BCM message from the given {@link ByteBuffer} expecting a valid BCM message at the
-     * buffer's position and a correct amount of remaining bytes.
+     * buffer's position and a correct number of remaining bytes.
      *
      * @param buffer the backing buffer for the message
      */
@@ -206,7 +206,7 @@ public int getCount() {
      * <ul>
      * <li><strong>When used with {@link BcmOpcode#TX_SETUP}</strong>:<br>
      * The broadcast manager sends {@link #getCount()} messages with this interval, then continues to
-     * send at {@link #getInterval2()}. If only one timer is needed set
+     * send at {@link #getInterval2()}. If only one timer is needed, set
      * {@link BcmMessage.Builder#count(int) count} to {@code 0} and {@link BcmMessage.Builder#interval1(Duration)} to {@code null}.</li>
      * <li><strong>When used with {@link BcmOpcode#RX_SETUP}</strong>:<br>
      * Send {@link BcmOpcode#RX_TIMEOUT} when a received message is not received again within the given
diff --git a/core/src/main/java/tel/schich/javacan/BcmOpcode.java b/core/src/main/java/tel/schich/javacan/BcmOpcode.java
@@ -34,12 +34,12 @@
  */
 public enum BcmOpcode {
     /**
-     * Create (cyclic) transmission task.
+     * Create a (cyclic) transmission task.
      */
     TX_SETUP(1),
 
     /**
-     * Remove (cyclic) transmission task.
+     * Remove a (cyclic) transmission task.
      */
     TX_DELETE(2),
 
diff --git a/core/src/main/java/tel/schich/javacan/CanChannels.java b/core/src/main/java/tel/schich/javacan/CanChannels.java
@@ -27,7 +27,6 @@
 /**
  * This utility class provides helper methods to easily create new channels similar to those in
  * {@link java.nio.file.Files} and {@link java.nio.channels.Channels}.
- * implementation.
  */
 public class CanChannels {
 
diff --git a/core/src/main/java/tel/schich/javacan/CanFilter.java b/core/src/main/java/tel/schich/javacan/CanFilter.java
@@ -60,7 +60,7 @@ public class CanFilter {
     private final int mask;
 
     /**
-     * Creates a filter to exactly matches the given ID.
+     * Creates a filter to exactly match the given ID.
      *
      * @param id the CAN ID to match
      */
@@ -89,7 +89,7 @@ public int getId() {
     }
 
     /**
-     * Gets the mask to used to match the CAN ID.
+     * Gets the mask to be used to match the CAN ID.
      *
      * @return the mask
      */
diff --git a/core/src/main/java/tel/schich/javacan/CanFrame.java b/core/src/main/java/tel/schich/javacan/CanFrame.java
@@ -200,7 +200,7 @@ public void getData(ByteBuffer dest) {
      *
      * @param dest the destination buffer
      * @param offset the offset in the destination buffer
-     * @param length the amount of bytes to write to the destination
+     * @param length the number of bytes to write to the destination
      */
     public void getData(byte[] dest, int offset, int length) {
         this.buffer.position(getDataOffset());
@@ -347,7 +347,7 @@ public static CanFrame create(int id, byte flags, byte[] data) {
      * @param flags the CAN FD flags, ignored for non-FD frames
      * @param data the data
      * @param offset the offset within data
-     * @param length amount of bytes to use from data
+     * @param length number of bytes to use from data
      * @return the newly created frame
      */
     public static CanFrame create(int id, byte flags, byte[] data, int offset, int length) {
@@ -377,7 +377,7 @@ public static CanFrame createExtended(int id, byte flags, byte[] data) {
      * @param flags the CAN FD flags, ignored for non-FD frames
      * @param data the data
      * @param offset the offset within data
-     * @param length amount of bytes to use from data
+     * @param length number of bytes to use from data
      * @return the newly created frame
      */
     public static CanFrame createExtended(int id, byte flags, byte[] data, int offset, int length) {
@@ -403,7 +403,7 @@ private static CanFrame create(int id, boolean extended, byte flags, byte[] data
      * @param flags the CAN FD flags, ignored for non-FD frames
      * @param data the data
      * @param offset the offset within data
-     * @param length amount of bytes to use from data
+     * @param length number of bytes to use from data
      * @return the newly created frame
      */
     public static CanFrame createRaw(int id, byte flags, byte[] data, int offset, int length) {
diff --git a/core/src/main/java/tel/schich/javacan/IsotpCanChannel.java b/core/src/main/java/tel/schich/javacan/IsotpCanChannel.java
@@ -81,7 +81,7 @@ public IsotpCanChannel(int sock) {
      *
      * @see <a href="https://man7.org/linux/man-pages/man2/read.2.html">read man page</a>
      * @param buffer the destination buffer
-     * @return the amount of bytes that have been read
+     * @return the number of bytes that have been read
      * @throws IOException if the native calls fail
      */
     public abstract int read(ByteBuffer buffer) throws IOException;
@@ -93,7 +93,7 @@ public IsotpCanChannel(int sock) {
      *
      * @see <a href="https://man7.org/linux/man-pages/man2/write.2.html">write man page</a>
      * @param buffer the source buffer
-     * @return the amount of bytes that have been written
+     * @return the number of bytes that have been written
      * @throws IOException if the native calls fail
      */
     public abstract int write(ByteBuffer buffer) throws IOException;
diff --git a/core/src/main/java/tel/schich/javacan/J1939CanChannel.java b/core/src/main/java/tel/schich/javacan/J1939CanChannel.java
@@ -82,7 +82,7 @@ public J1939CanChannel(int sock) {
      *
      * @see <a href="https://man7.org/linux/man-pages/man2/recv.2.html">read man page</a>
      * @param buffer the destination buffer
-     * @return the amount of bytes that have been received
+     * @return the number of bytes that have been received
      * @throws IOException if the native calls fail
      */
     public abstract long receive(ByteBuffer buffer) throws IOException;
@@ -95,7 +95,7 @@ public J1939CanChannel(int sock) {
      * @see <a href="https://man7.org/linux/man-pages/man2/recvmsg.2.html">recvmsg man page</a>
      * @param buffer the destination buffer
      * @param messageHeaderBuffer the buffer to read message headers into.
-     * @return the amount of bytes that have been read
+     * @return the number of bytes that have been read
      * @throws IOException if the native calls fail
      */
     public abstract long receive(ByteBuffer buffer, @Nullable J1939ReceiveMessageHeaderBuffer messageHeaderBuffer) throws IOException;
@@ -107,7 +107,7 @@ public J1939CanChannel(int sock) {
      *
      * @see <a href="https://man7.org/linux/man-pages/man2/send.2.html">send man page</a>
      * @param buffer the source buffer
-     * @return the amount of bytes that have been sent
+     * @return the number of bytes that have been sent
      * @throws IOException if the native calls fail
      */
     public abstract long send(ByteBuffer buffer) throws IOException;
@@ -120,7 +120,7 @@ public J1939CanChannel(int sock) {
      * @see <a href="https://man7.org/linux/man-pages/man2/send.2.html">send man page</a>
      * @param buffer the source buffer
      * @param destination the destination address to the send the message to.
-     * @return the amount of bytes that have been sent
+     * @return the number of bytes that have been sent
      * @throws IOException if the native calls fail
      */
     public abstract long send(ByteBuffer buffer, @Nullable J1939Address destination) throws IOException;
diff --git a/core/src/main/java/tel/schich/javacan/util/BufferHelper.java b/core/src/main/java/tel/schich/javacan/util/BufferHelper.java
@@ -114,7 +114,7 @@ public static long getPlatformLong(ByteBuffer buffer, int offset) {
      * @param buffer the buffer to write to
      * @param offset the memory location
      * @param value the value to write
-     * @return the amount of bytes written
+     * @return the number of bytes written
      */
     public static int putPlatformLong(ByteBuffer buffer, int offset, long value) {
         return PLATFORM_LONG_ACCESSOR.write(buffer, offset, value);
diff --git a/core/src/test/java/tel/schich/javacan/test/isotp/IsotpCanSocketOptionsTest.java b/core/src/test/java/tel/schich/javacan/test/isotp/IsotpCanSocketOptionsTest.java
@@ -115,7 +115,7 @@ void testWriteRead() throws Exception {
                 buf.rewind();
                 buf.get(out);
 
-                assertEquals(bytesWritten, bytesRead, "Written amount of bytes should be readable");
+                assertEquals(bytesWritten, bytesRead, "Written number of bytes should be readable");
                 assertArrayEquals(in, out, "What goes in must come out!");
             }
         }
diff --git a/epoll/src/main/java/tel/schich/javacan/platform/linux/epoll/EPollSelector.java b/epoll/src/main/java/tel/schich/javacan/platform/linux/epoll/EPollSelector.java
@@ -43,7 +43,7 @@
 /**
  * <p>
  * This is an implementation of the {@link IOSelector} API relying on Linux' epoll API to poll for
- * IO events from an arbitrary amount of file descriptors. The implementation is inspired by Java's
+ * IO events from an arbitrary number of file descriptors. The implementation is inspired by Java's
  * own epoll-based {@link java.nio.channels.Selector} implementation.
  * </p>
  * <p>
@@ -200,6 +200,11 @@ private static Set<SelectorRegistration.Operation> translateInterestsFromEPoll(i
         return newOps;
     }
 
+    /**
+     * Returns a set of all registrations associated with this epoll selector.
+     *
+     * @return the set of registrations
+     */
     public Set<SelectorRegistration<UnixFileDescriptor, ?>> getRegistrations() {
         return new HashSet<>(registrations);
     }
diff --git a/epoll/src/main/java/tel/schich/javacan/select/SelectorRegistration.java b/epoll/src/main/java/tel/schich/javacan/select/SelectorRegistration.java
@@ -47,7 +47,7 @@ public interface SelectorRegistration<HandleType, ChannelType extends Channel> e
     IOSelector<HandleType> getSelector();
 
     /**
-     * The channel that was registered,
+     * The channel which was registered.
      *
      * @return the channel
      */
diff --git a/epoll/src/main/java/tel/schich/javacan/util/CanBroker.java b/epoll/src/main/java/tel/schich/javacan/util/CanBroker.java
@@ -54,8 +54,8 @@
 /**
  * This class implements an event driven interface over several CAN interface to send and receive
  * {@link tel.schich.javacan.CanFrame}s over multiple {@link tel.schich.javacan.NetworkDevice}s. Received
- * frames are passed on to a {@link tel.schich.javacan.util.FrameHandler} for each specific interface.
- * Frames can be send either to individual interfaces or all at once.
+ * frames are passed on to a {@link tel.schich.javacan.util.FrameHandler} for each interface.
+ * Frames can be sent either to individual interfaces or all at once.
  */
 public class CanBroker extends EventLoop<UnixFileDescriptor, RawCanChannel> {
     private static final Logger LOGGER = LoggerFactory.getLogger(CanBroker.class);
diff --git a/epoll/src/main/java/tel/schich/javacan/util/CopyingMessageHandlerProxy.java b/epoll/src/main/java/tel/schich/javacan/util/CopyingMessageHandlerProxy.java
@@ -28,7 +28,7 @@
 
 /**
  * This simple {@link MessageHandler} proxy implementation copies the
- * shared read only buffer passed in by the event loop into a new buffer that is also writable.
+ * shared read-only buffer passed in by the event loop into a new buffer that is also writable.
  * Copying the buffer should be avoided if possible, but in some cases it is necessary, this proxy makes
  * sure the consumer can't accidentally forget to copy it.
  */
diff --git a/epoll/src/main/java/tel/schich/javacan/util/EventLoop.java b/epoll/src/main/java/tel/schich/javacan/util/EventLoop.java
@@ -258,7 +258,7 @@ protected boolean handleException(Thread thread, Throwable t, boolean terminal)
     /**
      * Closes the event loop by shutting it down and then
      *
-     * @throws IOException if any underlying operations has IO failures
+     * @throws IOException if any underlying operation has IO failures
      */
     @Override
     public final void close() throws IOException {
diff --git a/epoll/src/main/java/tel/schich/javacan/util/IsotpListener.java b/epoll/src/main/java/tel/schich/javacan/util/IsotpListener.java
@@ -96,7 +96,7 @@ public void addChannel(IsotpCanChannel ch, MessageHandler handler) throws IOExce
      * Removes the given {@link tel.schich.javacan.IsotpCanChannel} from this listener.
      *
      * @param ch the channel to remove
-     * @throws IOException if the underlying selector is unable cancel the registration
+     * @throws IOException if the underlying selector is unable to cancel the registration
      */
     public void removeChannel(IsotpCanChannel ch) throws IOException {
         synchronized (handlerLock) {
diff --git a/epoll/src/main/java/tel/schich/javacan/util/MessageHandler.java b/epoll/src/main/java/tel/schich/javacan/util/MessageHandler.java
@@ -33,11 +33,11 @@
 @FunctionalInterface
 public interface MessageHandler {
     /**
-     * Handles a received message. The given {@link java.nio.ByteBuffer} is read-only and its position and limit is set
+     * Handles a received message. The given {@link java.nio.ByteBuffer} is read-only and its position and limit is set,
      * so the message can be read from it.
      *
      * @param ch the channel that received the message
      * @param buffer the buffer containing the message
      */
     void handle(IsotpCanChannel ch, ByteBuffer buffer);
-}
+}
diff --git a/epoll/src/main/java/tel/schich/javacan/util/PollFunction.java b/epoll/src/main/java/tel/schich/javacan/util/PollFunction.java
@@ -25,7 +25,7 @@
 import java.time.Duration;
 
 /**
- * This interface abstracts the actually polling out of the {@link tel.schich.javacan.util.PollingThread}.
+ * This interface abstracts the actual polling out of the {@link tel.schich.javacan.util.PollingThread}.
  * An implementation should simply call {@link java.nio.channels.Selector#select(long)} or
  * {@link java.util.concurrent.BlockingQueue#poll(long, java.util.concurrent.TimeUnit)}, as long as it can be passed
  * a timeout in milliseconds.

Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@`
`27`	`27`
`28`	`28`	`/**`
`29`	`29`	`* The BcmFlag enum represent the Broadcast Manager message flags. When sending a message to the`
`30`		`- * broadcast manager the ‘flags’ element influence the behavior.`
	`30`	`+ * broadcast manager, the ‘flags’ element influences the behavior.`
`31`	`31`	`*`
`32`	`32`	`* @see <a href="https://www.kernel.org/doc/html/latest/networking/can.html#broadcast-manager-message-flags">`
`33`	`33`	`* Kernel CAN documentation: BCM message flags</a>`
Original file line number	Diff line number	Diff line change
`@@ -60,7 +60,7 @@ public class CanFilter {`
`60`	`60`	`private final int mask;`
`61`	`61`
`62`	`62`	`/**`
`63`		`- * Creates a filter to exactly matches the given ID.`
	`63`	`+ * Creates a filter to exactly match the given ID.`
`64`	`64`	`*`
`65`	`65`	`* @param id the CAN ID to match`
`66`	`66`	`*/`
`@@ -89,7 +89,7 @@ public int getId() {`
`89`	`89`	`}`
`90`	`90`
`91`	`91`	`/**`
`92`		`- * Gets the mask to used to match the CAN ID.`
	`92`	`+ * Gets the mask to be used to match the CAN ID.`
`93`	`93`	`*`
`94`	`94`	`* @return the mask`
`95`	`95`	`*/`