docs(sdk): document XStreamMatcher.kt

Author: xeruf

sdk/src/test/config/sc/helpers/XStreamMatcher.kt

@@ -3,7 +3,7 @@ package sc.helpers
 import com.thoughtworks.xstream.XStream
 import io.kotest.core.listeners.ProjectListener
 import io.kotest.core.spec.AutoScan
-import io.kotest.matchers.shouldBe
+import io.kotest.matchers.*
 import sc.networking.XStreamProvider
 
 @AutoScan
@@ -13,11 +13,16 @@ object XStreamProjectListener: ProjectListener {
     }
 }
 
+/** An XStream instance initialized with all active plugins. */
 lateinit var testXStream: XStream
 
+/** Asserts that the object is serialized to the given String
+ * and is equal to the original after deserialization. */
 inline infix fun <reified T: Any> T.shouldSerializeTo(serialized: String) =
         checkSerialization(testXStream, this, serialized.trimIndent())
 
+/** Asserts that the object is serialized to the given String.
+ * @param matcher checks the deserialized object, by default via equals and hashCode */
 inline fun <reified T: Any> checkSerialization(
         xStream: XStream, obj: T, serialized: String,
         matcher: (obj: T, deserialized: T) -> Unit = { original, deserialized ->