Packages

readmix

0.8.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 block_spec.ex
Raw

lib/readmix/block_spec.ex 

defmodule Readmix.BlockSpec do

  @moduledoc """

  Defines the structure for generated blocks found in documents.

  """



  alias Readmix.Generator



  @enforce_keys [:generator, :content, :raw_header, :raw_footer, :file, :loc]

  defstruct @enforce_keys



  @type t :: %__MODULE__{

          generator: {atom, atom, keyword},

          content: [Generator.block()],

          raw_header: String.t(),

          raw_footer: String.t(),

          file: String.t(),

          loc: nil | {pos_integer() | pos_integer()}

        }

end