Skip to content

Commit

Permalink
Merge pull request #20 from geny200/chore/update-doc
Browse files Browse the repository at this point in the history
#14 Updated documentation for `useElementNameAsDiscriminator`
  • Loading branch information
valentiay authored Jun 23, 2024
2 parents bfe6716 + a5eaee6 commit 1ad6a5a
Showing 1 changed file with 4 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,10 @@ import phobos.Namespace
* "http://www.w3.org/2001/XMLSchema-instance", as defined in https://www.w3.org/TR/xmlschema-1/#xsi_type
* @param useElementNameAsDiscriminator
* Forces codecs to use element name as sealed trait discriminator, instead of special attribute. This setting
* overrides [[discriminatorLocalName]] and [[discriminatorNamespace]]. Default value is "false".
* overrides [[discriminatorLocalName]] and [[discriminatorNamespace]]. Default value is "false". Warning: You must
* use the "@default" annotation (see [[phobos.syntax.default]]) to fields with type for which
* [[useElementNameAsDiscriminator]] set as "true". See
* [[https://github.com/valentiay/phobos/blob/master/modules/core/src/main/scala/phobos/configured/ElementCodecConfig.scala#L44 issue]]
* @param transformConstructorNames
* Function to transform constructor names, that are used as sealed trait discriminator. No transformation is applied
* by default.
Expand Down

0 comments on commit 1ad6a5a

Please sign in to comment.