Implement IgnoreTransientDefaultMarker - improve doc

sebaciv · sebaciv · commit 398206004377 · 2024-09-21T17:39:11.000+02:00
diff --git a/core/src/main/scala/com/avsystem/commons/serialization/IgnoreTransientDefaultMarker.scala b/core/src/main/scala/com/avsystem/commons/serialization/IgnoreTransientDefaultMarker.scala
@@ -7,9 +7,9 @@ package serialization
   * representation. Deserialization behavior remains <b>unchanged</b>. If a field is missing from the input, the default
   * value will be used as usual.
   *
-  * This annotation can be helpful when using the same model class in multiple contexts with different serialization
+  * This marker can be helpful when using the same model class in multiple contexts with different serialization
   * formats that have conflicting requirements for handling default values.
   *
-  * @see [[CustomMarkersOutputWrapper]]
+  * @see [[CustomMarkersOutputWrapper]] for an easy way to add markers to existing [[Output]] implementations
   */
 object IgnoreTransientDefaultMarker extends CustomEventMarker[Unit]

Original file line number	Diff line number	Diff line change
`@@ -7,9 +7,9 @@ package serialization`
`7`	`7`	`* representation. Deserialization behavior remains <b>unchanged</b>. If a field is missing from the input, the default`
`8`	`8`	`* value will be used as usual.`
`9`	`9`	`*`
`10`		`- * This annotation can be helpful when using the same model class in multiple contexts with different serialization`
	`10`	`+ * This marker can be helpful when using the same model class in multiple contexts with different serialization`
`11`	`11`	`* formats that have conflicting requirements for handling default values.`
`12`	`12`	`*`
`13`		`- * @see [[CustomMarkersOutputWrapper]]`
	`13`	`+ * @see [[CustomMarkersOutputWrapper]] for an easy way to add markers to existing [[Output]] implementations`
`14`	`14`	`*/`
`15`	`15`	`object IgnoreTransientDefaultMarker extends CustomEventMarker[Unit]`