Packages

readmix

0.7.1
0.8.1 0.8.0 0.7.2 0.7.1 0.7.0 0.6.3 0.6.2 0.6.1 0.6.0 0.5.0 0.4.1 0.4.0 0.3.0 0.2.2 0.2.1 0.2.0 0.1.1 0.1.0

A tool to generate parts of documentation with custom generator functions.

HexDocs

Current section

Files

Jump to
Readme
18 Versions
2 Dependencies
Dependants
Files
Activity
readmix lib readmix generated.ex
Raw

lib/readmix/generated.ex 

defmodule Generated do

  @moduledoc """

  Struct representing a generated block in Readmix.

  """



  @enforce_keys [

    :mod,

    :action,

    :spec,

    :section_name,

    :params,

    :sub_blocks

  ]

  defstruct @enforce_keys ++ [:rendered]



  @type t :: %__MODULE__{

          mod: module() | nil,

          action: atom() | nil,

          params: keyword(),

          section_name: String.t() | nil,

          spec: Readmix.BlockSpec.t() | nil,

          sub_blocks: [term()],

          rendered: [term()]

        }

end