Readmix.Docs (readmix v0.4.1)

Utilities for generating documentation for Readmix generators.

Summary

Functions

Generates documentation for the actions registered with Readmix.Generator.action/2.

Generates documentation for actions defined as a keyword list.

Functions

generate()

(macro)

Generates documentation for the actions registered with Readmix.Generator.action/2.

Example

defmodule MyGenerator do
  use Readmix.Generator

  action :greeting, params [name: :string, required: true]

  @moduledoc """
  A block generator

  #{Readmix.Docs.generate()}
  """

  def greeting(args, _) do
    {:ok, ["hello ", args[:name]]}
  end
end

generate(actions)

Generates documentation for actions defined as a keyword list.

defmodule MyGenerator do
  @behaviour Readmix.Generator

  @actions [
    greeting: [
      params [name: :string, required: true]
    ]
  ]

  @moduledoc """
  A block generator

  #{Readmix.Docs.generate(@actions)}
  """

  @impl true
  def actions, do: @actions

  @impl true
  def generate(:greeting, args, _) do
    {:ok, ["hello ", args[:name]]}
  end
end