diff --git a/docs/Classes/ArrayType.html b/docs/Classes/ArrayType.html index 6834fd54..77fcc2bd 100644 --- a/docs/Classes/ArrayType.html +++ b/docs/Classes/ArrayType.html @@ -14,7 +14,7 @@
-

Sourcery Docs (100% documented)

+

Sourcery Docs (99% documented)

View on GitHub

@@ -145,6 +145,14 @@ +
  • + Other Classes + +
  • Other Protocols
    • +
  • + Other Classes + +
  • Other Protocols
    • +
  • + Other Classes + +
  • Other Protocols
    • +
  • + Other Classes + +
  • Other Protocols
    • +
  • + Other Classes + +
  • Other Protocols
    • +
  • + Other Classes + +
  • Other Protocols
    • +
  • + Other Classes + +
  • Other Protocols
    • +
  • + Other Classes + +
  • Other Protocols
    • +
  • + Other Classes + +
  • Other Protocols
    • +
  • + Other Classes + +
  • Other Protocols
    • +
  • + Other Classes + +
  • Other Protocols
    • +
  • + Other Classes + +
  • Other Protocols
    • +
  • + Other Classes + +
  • Other Protocols diff --git a/docs/Classes/ProtocolComposition.html b/docs/Classes/ProtocolComposition.html index 61e6a766..6623cf63 100644 --- a/docs/Classes/ProtocolComposition.html +++ b/docs/Classes/ProtocolComposition.html @@ -14,7 +14,7 @@
    -

    Sourcery Docs (100% documented)

    +

    Sourcery Docs (99% documented)

    View on GitHub

    @@ -145,6 +145,14 @@
    • +
  • + Other Classes + +
  • Other Protocols
    • +
  • + Other Classes + +
  • Other Protocols
    • +
  • + Other Classes + +
  • Other Protocols
    • +
  • + Other Classes + +
  • Other Protocols
    • +
  • + Other Classes + +
  • Other Protocols
    • +
  • + Other Classes + +
  • Other Protocols
    • +
  • + Other Classes + +
  • Other Protocols
      diff --git a/docs/Classes/Types.html b/docs/Classes/Types.html index 9b5e8c39..515321e9 100644 --- a/docs/Classes/Types.html +++ b/docs/Classes/Types.html @@ -14,7 +14,7 @@
      -

      Sourcery Docs (100% documented)

      +

      Sourcery Docs (99% documented)

      View on GitHub

      @@ -145,6 +145,14 @@
    • +
  • + Other Classes + +
  • Other Protocols
    • +
  • + Other Classes + +
  • Other Protocols
    • +
  • + Other Classes + +
  • Other Protocols
    • +
  • + Other Classes + +
  • Other Protocols
    • +
  • + Other Classes + +
  • Other Protocols
    • +
  • + Other Classes + +
  • Other Protocols
    • +
  • + Other Classes + +
  • Other Protocols
    • +
  • + Other Classes + +
  • Other Protocols
    • +
  • + Other Classes + +
  • Other Protocols
    • +
  • + Other Classes + +
  • Other Protocols
    • +
  • + Other Classes + +
  • Other Protocols
    • +
  • + Other Classes + +
  • Other Protocols
    • +
  • + Other Classes + +
  • Other Protocols
    • +
  • + Other Classes + +
  • Other Protocols
    • +
  • + Other Classes + +
  • Other Protocols
    • +
  • + Other Classes + +
  • Other Protocols
    • +
  • + Other Classes + +
  • Other Protocols
    • +
  • + Other Classes + +
  • Other Protocols
    • +
  • + Other Classes + +
  • Other Protocols
    • +
  • + Other Classes + +
  • Other Protocols
    • +
  • + Other Classes + +
  • Other Protocols
    • +
  • + Other Classes + +
  • Other Protocols -

    You can also use partial templates using include tag. Partial template is loaded from the path of a template that inculdes it. include tags also supports loading templates from relative path, i.e. {% include "partials/MyPartial.stencil"%} used in the template located in templates directory will load template from templates/partials directory.

    +

    You can also use partial templates using include tag. Partial template is loaded from the path of a template that includes it. include tags also supports loading templates from relative path, i.e. {% include "partials/MyPartial.stencil"%} used in the template located in templates directory will load template from templates/partials directory.

    Note: You can only load partial templates from child directories of the including template directory, so {% include "../MyPartial.stencil"%} is not supported.

    -

    Sourcery treat all the templates as independent and so will generate files based on partial templates too. To avoid that use exclude in configuration file.

    +

    Sourcery treats all the templates as independent and so will generate files based on partial templates too. To avoid that use exclude in configuration file.

    Swift templates

    Swift templates syntax is very similar to EJS:

    @@ -256,7 +264,7 @@ Sourcery also uses its extension here, put it in some path and pass it when running Sourcery. Otherwise JavaScript templates will be ignored (you will see a warning in the console output).

    -

    You can also use SourceryJS framework independently of Sourcery. You can add it as a Carthge or SPM dependency.

    +

    You can also use SourceryJS framework independently of Sourcery. You can add it as a Carthage or SPM dependency.

    Using Source Annotations

    Sourcery supports annotating your classes and variables with special annotations, similar to how attributes work in Rust / Java

    @@ -279,7 +287,7 @@ Sourcery also uses its extension var secondVariable: Int     -

    To group annotations of the same domain you can use annotation namespcases:

    +

    To group annotations of the same domain you can use annotation namespaces:

    // sourcery:decoding: key="first", default=0
   var firstVariable: Int
    @@ -293,7 +301,7 @@ Sourcery also uses its extension     var local{{ variable.name|capitalize }} = json["{{ variable.annotations.jsonKey }}"] as? {{ variable.typeName }} {% endif %} -

    Checking for existance of at least one annotation:

    +

    Checking for existence of at least one annotation:

    Sometimes it is desirable to only generate code if there’s at least one field annotated.

    {% if type.variables|annotated:"jsonKey" %}{% for var in type.variables|instance|annotated:"jsonKey" %}