v5.0.14-RC: Added ScalaDocs for CoreXXX classes

core/shared/src/main/scala/sigma/data/SigmaPropCodes.scala

@@ -3,7 +3,7 @@ package sigma.data
 import sigma.ast.TypeCodes.LastConstantCode
 import supertagged.TaggedType
 
-/** Encoding of sigma proposition nodes.
+/** Opcodes of sigma proposition nodes.
   *
   * @see SigmaBoolean.opCode
   */

core/shared/src/main/scala/sigma/serialization/CoreByteWriter.scala

@@ -5,6 +5,9 @@ import scorex.util.serialization.{VLQByteBufferWriter, Writer}
 import sigma.ast.SType
 import sigma.serialization.CoreByteWriter.{Bits, DataInfo, U, Vlq, ZigZag}
 
+/** Implementation of [[Writer]] provided by `sigma-core` module.
+  * @param w destination [[Writer]] to which all the call got delegated.
+  */
 class CoreByteWriter(val w: Writer) extends Writer {
   type CH = w.CH
 

core/shared/src/main/scala/sigma/serialization/CoreSerializer.scala

@@ -6,25 +6,31 @@ import sigma.data.SigmaConstants
 
 import java.nio.ByteBuffer
 
+/** Implementation of [[Serializer]] provided by `sigma-core` module. */
 abstract class CoreSerializer[TFamily, T <: TFamily] extends Serializer[TFamily, T, CoreByteReader, CoreByteWriter] {
 
-  def error(msg: String) = throw new SerializerException(msg, None)
+  def error(msg: String) = throw SerializerException(msg, None)
 
+  /** Serializes the given 'obj' to a new array of bytes using this serializer. */
   final def toBytes(obj: T): Array[Byte] = {
     val w = CoreSerializer.startWriter()
     serialize(obj, w)
     w.toBytes
   }
 
+  /** Deserializes `bytes` to an object of this [[TFamily]] using this serializer.
+    * The actual class of the returned object is expected to be descendant of [[TFamily]].
+    */
   final def fromBytes(bytes: Array[Byte]): TFamily = {
     parse(CoreSerializer.startReader(bytes))
   }
 }
 
 object CoreSerializer {
-  type Position = Int
-
+  /** Max length of Box.propositionBytes collection */
   val MaxPropositionSize: Int = SigmaConstants.MaxPropositionBytes.value
+
+  /** Max tree depth should not be greater then provided value */
   val MaxTreeDepth: Int = SigmaConstants.MaxTreeDepth.value
 
   /** Helper function to be use in serializers.