typo fixes

Author: raydac

jbbp/src/main/java/com/igormaznitsa/jbbp/JBBPParser.java

@@ -138,7 +138,7 @@ public final class JBBPParser {
    *
    * @param source                   the source script to parse binary blocks and streams, must
    *                                 not be null
-   * @param bitOrder                 the bit order for bit reading operations, must not be null
+   * @param bitOrder                 the bit order for a bit reading operations, must not be null
    * @param customFieldTypeProcessor custom field type processor for the parser instance, it can be null
    * @param flags                    special flags for parsing process
    * @see #FLAG_SKIP_REMAINING_FIELDS_IF_EOF
@@ -185,7 +185,7 @@ public static JBBPParser prepare(final String script, final JBBPBitOrder bitOrde
   }
 
   /**
-   * Prepare a parser for a script with defined bit order and special flags.
+   * Prepare a parser for a script with defined a bit order and special flags.
    *
    * @param script   a text script contains field order and types reference, it
    *                 must not be null
@@ -203,7 +203,7 @@ public static JBBPParser prepare(final String script, final JBBPBitOrder bitOrde
   }
 
   /**
-   * Prepare a parser for a script with defined bit order and special flags.
+   * Prepare a parser for a script with defined a bit order and special flags.
    *
    * @param script                   a text script contains field order and types reference, it
    *                                 must not be null
@@ -297,7 +297,7 @@ public JBBPParser setExpressionArraySizeController(
    * @param inStream                      the input stream, must not be null
    * @param positionAtCompiledBlock       the current position in the compiled script
    *                                      block
-   * @param varFieldProcessor             a processor to process var fields, it can be null
+   * @param varFieldProcessor             a processor to process var fields, it can be null,
    *                                      but it will thrown NPE if a var field is met
    * @param namedNumericFieldMap          the named numeric field map
    * @param positionAtNamedFieldList      the current position at the named field

jbbp/src/main/java/com/igormaznitsa/jbbp/compiler/JBBPCompiler.java

@@ -114,12 +114,12 @@ public final class JBBPCompiler {
    */
   public static final int FLAG_NAMED = 0x10;
   /**
-   * The Byte-Code Flag shows that the field is an array but it must be omitted
+   * The Byte-Code Flag shows that the field is an array, but it must be omitted
    * for unlimited field arrays.
    */
   public static final int FLAG_ARRAY = 0x20;
   /**
-   * The Byte-Code Flag shows that a multi-byte field must be decoded as
+   * The Byte-Code Flag shows that a multibyte field must be decoded as
    * Little-endian one.
    */
   public static final int FLAG_LITTLE_ENDIAN = 0x40;
@@ -726,7 +726,7 @@ private static final class StructStackItem {
      *                             start
      * @param startStructureOffset the offset of the start structure byte-code
      *                             instruction
-     * @param arrayToReadTillEnd   if true then it is array to read till end
+     * @param arrayToReadTillEnd   if true then it is an array to read till end
      * @param code                 the start byte code
      * @param token                the token
      */

jbbp/src/main/java/com/igormaznitsa/jbbp/compiler/JBBPCompilerUtils.java

@@ -74,7 +74,7 @@ public static JBBPNamedFieldInfo findForFieldPath(final String fieldPath,
   }
 
   /**
-   * Check a field in a compiled list defined by its named field info, that the field is not an array and it is not inside a structure array.
+   * Check a field in a compiled list defined by it's named field info, that the field is not an array and it is not inside a structure array.
    *
    * @param fieldToCheck   a named field info to be checked, must not be null
    * @param namedFieldList a named field info list, must not be null.

jbbp/src/main/java/com/igormaznitsa/jbbp/compiler/JBBPNamedFieldInfo.java

@@ -21,7 +21,7 @@
 
 /**
  * The Class describes a named field info item. Such objects are presented
- * inside of compiled blocks only for fields which have names.
+ * inside compiled blocks only for fields which have names.
  *
  * @since 1.0
  */

jbbp/src/main/java/com/igormaznitsa/jbbp/compiler/conversion/CompiledBlockVisitor.java

@@ -252,7 +252,7 @@ public void visitValField(int offsetInCompiledBlock,
    * @param primitiveType          the primitive type
    * @param nullableNameFieldInfo  field info, null if the field is anonymous one
    * @param byteOrder              byte order for the field, must not be null
-   * @param readWholeStreamAsArray if true then it is array with unknown size till the stream end
+   * @param readWholeStreamAsArray if true then it is an array with unknown size till the stream end
    * @param altFieldType           flag shows that field type is alternative one, INT should be recognized as FLOAT and LONG as DOUBLE and BOOL as STRING
    * @param nullableArraySize      array size if the field is array, null if the field is not array or variable length array
    * @see JBBPCompiler#CODE_BYTE

jbbp/src/main/java/com/igormaznitsa/jbbp/compiler/conversion/JBBPToJavaConverter.java

@@ -1689,7 +1689,7 @@ public Builder setHeadComment(final String text) {
     /**
      * Disable generate fields, useful if some super class extended and its
      * fields should be used instead of generated ones. If disable then all code
-     * will be generated but without class fields. By default field generate is
+     * will be generated but without class fields. By default, field generate is
      * enabled.
      *
      * @return the builder instance, must not be null
@@ -1701,7 +1701,7 @@ public Builder disableGenerateFields() {
     }
 
     /**
-     * Build converter with provided parameters. NB! It locks builder parameters
+     * Build converter with provided parameters. NB! It locks builder parameters,
      * and they can't be changed in future.
      *
      * @return a converter instance.

jbbp/src/main/java/com/igormaznitsa/jbbp/compiler/tokenizer/JBBPTokenizer.java

@@ -126,10 +126,10 @@ public JBBPTokenizer(final String str,
   }
 
   /**
-   * Case sensitive check that the name is among global reserved ones.
+   * Case-sensitive check that the name is among global reserved ones.
    *
    * @param name the name to check, must not be null
-   * @return true if the name is global reserved one, false otherwise.
+   * @return true if the name is globally reserved one, false otherwise.
    */
   public static boolean isGlobalReservedName(final String name) {
     return GLOBAL_RESERVED_TYPE_NAMES.contains(name);

jbbp/src/main/java/com/igormaznitsa/jbbp/compiler/varlen/JBBPExpressionEvaluator.java

@@ -94,7 +94,7 @@ public final class JBBPExpressionEvaluator implements JBBPIntegerValueEvaluator
    */
   private static final int CODE_MOD = 11;
   /**
-   * Code for bit OR '|' operator.
+   * Code for a bit OR '|' operator.
    */
   private static final int CODE_OR = 12;
   /**
@@ -446,7 +446,7 @@ private static int getParsed(String number, int unaryOperatorCode) {
    * Encode code of an operator to code of similar unary operator.
    *
    * @param code a code of operator.
-   * @return code of an unary similar operator if it exists, the same code otherwise
+   * @return code of a unary similar operator if it exists, the same code otherwise
    */
   private static int codeToUnary(final int code) {
     final int result;

jbbp/src/main/java/com/igormaznitsa/jbbp/exceptions/JBBPFinderException.java

@@ -32,7 +32,7 @@ public class JBBPFinderException extends JBBPException {
   private final String nameOrPath;
 
   /**
-   * The Field type of a field to be searched. It may contain null.
+   * The Field type of field to be searched. It may contain null.
    */
   private final Class<? extends JBBPAbstractField> fieldType;
 

jbbp/src/main/java/com/igormaznitsa/jbbp/io/JBBPBitInputStream.java

@@ -756,7 +756,7 @@ public float[] readFloatArray(
   /**
    * Read a unsigned short value from the stream.
    *
-   * @param byteOrder he order of bytes to be used to decode the read value
+   * @param byteOrder the order of bytes to be used to decode the read value
    * @return the unsigned short value read from stream
    * @throws IOException  it will be thrown for any transport problem during the
    *                      operation
@@ -943,7 +943,7 @@ public byte readBitField(final JBBPBitNumber numOfBitsToRead) throws IOException
   /**
    * Read number of bits from the input stream. It reads bits from input stream
    * since 0 bit and make reversion to return bits in the right order when 0 bit
-   * is 0 bit. if the stream is completed early than the data read then reading
+   * is 0 bit. if the stream is completed earlier than the data read then reading
    * is just stopped and read value returned. The First read bit is placed as
    * 0th bit.
    *