fix a number of spelling/grammar issues

Author: pschichtel

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 {

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;
 

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>

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

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),
 

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 {
 

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
      */

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) {

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;

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;