formatting

Author: raydac

src/main/java/com/igormaznitsa/prologparser/ParserContext.java

@@ -25,6 +25,11 @@
 
 import java.util.Map;
 
+/**
+ * Context which provides flags and operator storage for a prolog parser.
+ *
+ * @see PrologParser
+ */
 public interface ParserContext {
   /**
    * Empty flags, no any flag defined.

src/main/java/com/igormaznitsa/prologparser/ParserContextChain.java

@@ -31,6 +31,9 @@
 
 import static java.util.Arrays.stream;
 
+/**
+ * Auxiliary class allows to make chain of prolog contexts.
+ */
 public class ParserContextChain implements ParserContext {
   private final ParserContext[] contexts;
   private final int tokenizerFlags;

src/main/java/com/igormaznitsa/prologparser/exceptions/CharBufferOverflowException.java

@@ -22,7 +22,7 @@
 package com.igormaznitsa.prologparser.exceptions;
 
 /**
- * Specialized exception shows that allowed char buffer size of one buffers in a tokenizer is reached
+ * Specialized exception shows that allowed char buffer size of one buffers in a tokenizer is reached.
  */
 public class CharBufferOverflowException extends PrologParserException {
 

src/main/java/com/igormaznitsa/prologparser/exceptions/PrologParserException.java

@@ -56,7 +56,7 @@ public PrologParserException(final String text, final int line, final int pos, f
   }
 
   /**
-   * Get the error line
+   * Get the error line, first line has index 1
    *
    * @return the error line, -1 if the line is undefined
    */
@@ -65,7 +65,7 @@ public int getLine() {
   }
 
   /**
-   * Get the error line position
+   * Get the error line position, first position has index 1
    *
    * @return the error line position, -1 if the position is undefined
    */

src/main/java/com/igormaznitsa/prologparser/terms/OpContainer.java

@@ -31,7 +31,7 @@
 import java.util.stream.Stream;
 
 /**
- * Container of operators which have same name.
+ * Container of operators which have same name but differently associative.
  */
 public final class OpContainer extends SpecServiceCompound {
 

src/main/java/com/igormaznitsa/prologparser/tokenizer/Op.java

@@ -126,7 +126,7 @@ public final class Op extends SpecServiceCompound {
   ));
 
   /**
-   * Set of operators is specific for SWI Prolog use
+   * Set of operators is specific for SWI Prolog use.
    */
   public static final List<Op> SWI_SPECIFIC = Collections.unmodifiableList(Arrays.asList(
       MODIFIERS,

src/main/java/com/igormaznitsa/prologparser/utils/AssertUtils.java

@@ -44,7 +44,7 @@ public static <T> T assertNotNull(final T value) {
   }
 
   /**
-   * Check string is not null and is not empty
+   * Check string is not null and is not empty.
    *
    * @param value the string to check
    * @return the same value if it is not null and not empty