cosmetics and docs

Author: ghik

commons-core/src/main/scala/com/avsystem/commons/serialization/GenCodec.scala

@@ -142,6 +142,12 @@ object GenCodec extends RecursiveAutoCodecs with TupleGenCodecs {
   def createNonNullList[T](readFun: ListInput => T, writeFun: (ListOutput, T) => Any) =
     createList(readFun, writeFun, allowNull = false)
 
+  /**
+    * Helper method to manually implement a `GenCodec` that writes an object. NOTE: in most cases the easiest way to
+    * have a custom object codec is to manually implement `apply` and `unapply`/`unapplySeq` methods in companion object
+    * of your type or use [[fromApplyUnapplyProvider]] if the type comes from a third party code and you can't
+    * modify its companion object.
+    */
   def createObject[T](readFun: ObjectInput => T, writeFun: (ObjectOutput, T) => Any, allowNull: Boolean) =
     new ObjectCodec[T] {
       def nullable = allowNull
@@ -214,6 +220,11 @@ object GenCodec extends RecursiveAutoCodecs with TupleGenCodecs {
     }
   }
 
+  /**
+    * Convenience base class for `GenCodec`s that serialize values as objects.
+    * NOTE: if you need to implement a custom `GenCodec` that writes an object, the best way to do it is to have
+    * manually implemented `apply` and `unapply` in companion object or by using [[GenCodec.fromApplyUnapplyProvider]].
+    */
   trait ObjectCodec[T] extends NullSafeCodec[T] {
     def readObject(input: ObjectInput): T
     def writeObject(output: ObjectOutput, value: T): Unit

commons-core/src/main/scala/com/avsystem/commons/serialization/macroCodecs.scala

@@ -151,30 +151,31 @@ abstract class FlatSealedHierarchyCodec[T](
       }
     }
 
-    def read(): T = if (input.hasNext) {
-      val fi = input.nextField()
-      if (fi.fieldName == caseFieldName) readCase(fi)
-      else if (!oooFields.tryReadField(fi)) {
-        if (caseDependentFieldNames.contains(fi.fieldName)) {
-          if (defaultCaseIdx != -1) {
-            val defaultCaseName = caseNames(defaultCaseIdx)
-            val wrappedInput = new DefaultCaseObjectInput(fi, input, defaultCaseName)
-            readFlatCase(defaultCaseName, oooFields, wrappedInput, caseDeps(defaultCaseIdx))
+    def read(): T =
+      if (input.hasNext) {
+        val fi = input.nextField()
+        if (fi.fieldName == caseFieldName) readCase(fi)
+        else if (!oooFields.tryReadField(fi)) {
+          if (caseDependentFieldNames.contains(fi.fieldName)) {
+            if (defaultCaseIdx != -1) {
+              val defaultCaseName = caseNames(defaultCaseIdx)
+              val wrappedInput = new DefaultCaseObjectInput(fi, input, defaultCaseName)
+              readFlatCase(defaultCaseName, oooFields, wrappedInput, caseDeps(defaultCaseIdx))
+            } else {
+              missingCase(fi.fieldName)
+            }
           } else {
-            missingCase(fi.fieldName)
+            fi.skip()
+            read()
           }
         } else {
-          fi.skip()
           read()
         }
+      } else if (defaultCaseIdx != -1) {
+        readFlatCase(caseNames(defaultCaseIdx), oooFields, input, caseDeps(defaultCaseIdx))
       } else {
-        read()
+        missingCase
       }
-    } else if (defaultCaseIdx != -1) {
-      readFlatCase(caseNames(defaultCaseIdx), oooFields, input, caseDeps(defaultCaseIdx))
-    } else {
-      missingCase
-    }
 
     input.peekField(caseFieldName) match {
       case Opt(fi) => readCase(fi)