fixes in javadoc

Author: raydac

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

@@ -52,7 +52,7 @@ public interface JBBPVarFieldProcessor {
    * be null, it can be used for access to already read values of another
    * numeric fields.
    * @return a read field object, it must not return null
-   * @throws IOException 
+   * @throws IOException it should be thrown for transport errors
    */
   JBBPAbstractField readVarField(JBBPBitInputStream inStream, JBBPNamedFieldInfo fieldName, int extraValue, JBBPByteOrder byteOrder, JBBPNamedNumericFieldMap numericFieldMap) throws IOException;
 }

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

@@ -125,7 +125,7 @@ public Builder setNamedFieldData(final List<JBBPNamedFieldInfo> namedFields) {
     /**
      * Set the variable size array evaluators
      *
-     * @param evaluators
+     * @param evaluators list of evaluators, it can be null
      * @return this object
      */
     public Builder setArraySizeEvaluators(final List<JBBPIntegerValueEvaluator> evaluators) {

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

@@ -629,7 +629,7 @@ public JBBPOut Short(final int value) throws IOException {
    * @param str the string which chars will be written, must not be null
    * @return the DSL session
    * @throws IOException it will be thrown for transport errors
-   * @sine 1.1
+   * @since 1.1
    */
   public JBBPOut Short(final String str) throws IOException {
     assertNotEnded();

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

@@ -29,7 +29,7 @@ public interface JBBPOutVarProcessor {
    * @param outStream the output stream for the context, must not be null
    * @param args optional arguments, can be null
    * @return true is to continue processing of DSL commands, false skip all commands till the End()
-   * @throws IOException 
+   * @throws IOException it should be thrown for transport errors
    */
   boolean processVarOut(JBBPOut context, JBBPBitOutputStream outStream, Object ... args) throws IOException;
 }

src/main/java/com/igormaznitsa/jbbp/mapper/Bin.java

@@ -108,7 +108,7 @@
 
   /**
    * Just either description of the field or some remark.
-   * @return 
+   * @return the comment as String
    * @see JBBPTextWriter#Bin(java.lang.Object...) 
    * @since 1.1
    */

src/main/java/com/igormaznitsa/jbbp/model/JBBPFieldStruct.java

@@ -15,9 +15,11 @@
  */
 package com.igormaznitsa.jbbp.model;
 
+import com.igormaznitsa.jbbp.JBBPParser;
 import com.igormaznitsa.jbbp.compiler.JBBPNamedFieldInfo;
 import com.igormaznitsa.jbbp.exceptions.JBBPFinderException;
 import com.igormaznitsa.jbbp.exceptions.JBBPTooManyFieldsFoundException;
+import com.igormaznitsa.jbbp.io.JBBPOut;
 import com.igormaznitsa.jbbp.mapper.JBBPMapper;
 import com.igormaznitsa.jbbp.mapper.JBBPMapperCustomFieldProcessor;
 import com.igormaznitsa.jbbp.model.finder.JBBPFieldFinder;
@@ -287,7 +289,7 @@ public <T> T mapTo(final String path, final Class<T> mappingClass) {
    * must not be null and must have the default constructor
    * @param flags special flags to tune mapping process
    * @return a mapped instance of the class, must not be null
-   * @see #FLAG_IGNORE_MISSING_VALUES
+   * @see JBBPMapper#FLAG_IGNORE_MISSING_VALUES
    * @since 1.1
    */
   public <T> T mapTo(final String path, final Class<T> mappingClass, final int flags) {
@@ -320,7 +322,7 @@ public <T> T mapTo(final String path, final Class<T> mappingClass, final JBBPMap
    * @param customFieldProcessor a custom field processor to provide values for custom mapping fields, it can be null if there is not any custom field
    * @param flags special flags to tune mapping process
    * @return a mapped instance of the class, must not be null
-   * @see #FLAG_IGNORE_MISSING_VALUES
+   * @see JBBPMapper#FLAG_IGNORE_MISSING_VALUES
    * @since 1.1
    */
   public <T> T mapTo(final String path, final Class<T> mappingClass, final JBBPMapperCustomFieldProcessor customFieldProcessor, final int flags) {
@@ -347,7 +349,7 @@ public Object mapTo(final Object objectToMap) {
    * @param flags special flags to tune mapping process
    * @return the same object from the arguments but with filled fields by values
    * of the structure
-   * @see #FLAG_IGNORE_MISSING_VALUES
+   * @see JBBPMapper#FLAG_IGNORE_MISSING_VALUES
    * @since 1.1
    */
   public Object mapTo(final Object objectToMap, final int flags) {
@@ -378,7 +380,7 @@ public Object mapTo(final Object objectToMap, final JBBPMapperCustomFieldProcess
    * @param flags special flags to tune mapping process
    * @return the same object from the arguments but with filled fields by values
    * of the structure
-   * @see #FLAG_IGNORE_MISSING_VALUES
+   * @see JBBPMapper#FLAG_IGNORE_MISSING_VALUES
    * @since 1.1
    */
   public Object mapTo(final Object objectToMap, final JBBPMapperCustomFieldProcessor customFieldProcessor, final int flags) {

src/main/java/com/igormaznitsa/jbbp/utils/JBBPTextWriter.java

@@ -371,8 +371,8 @@ public interface Extra {
      * @param context the context, must not be null
      * @param id an optional object id
      * @param obj an object to be converted into string, must not be null
-     * @return
-     * @throws IOException
+     * @return string representation of the object
+     * @throws IOException it can be thrown for transport error
      */
     String doConvertObjToStr(JBBPTextWriter context, int id, Object obj) throws IOException;
 
@@ -624,6 +624,7 @@ public JBBPTextWriter(final Writer out, final JBBPByteOrder byteOrder) {
    * @param startValueLinePrefix prefix before the first value on line, can be
    * null.
    * @param commentPrefix prefix before comments, can be null.
+   * @param hrPrefix prefix for horizontal rule
    * @param valueDelimiter delimiter between values, can be null
    */
   public JBBPTextWriter(
@@ -1390,7 +1391,7 @@ public JBBPTextWriter SetHR(final String prefix, final int length, final char ch
    *
    * @return the context
    * @throws IOException it will be thrown for transport errors
-   * @see #EnableComments()t
+   * @see #EnableComments()
    * @see #DisableComments()
    */
   public JBBPTextWriter HR() throws IOException {
@@ -1509,7 +1510,7 @@ public JBBPTextWriter Obj(final int objId, final Object[] array, int off, int le
    *
    * @param objs array of object marked by Bin annotation
    * @return the context
-   * @throws IOException
+   * @throws IOException it will be thrown if transport errors
    */
   public JBBPTextWriter Bin(final Object... objs) throws IOException {
     if (this.mappedClassObserver == null) {