Skogsra.Docs (Skogsrå v2.5.3)

This module defines the documentation generators.

Summary

Types

docs()

Custom docs.

function_name()

Function name.

Functions

gen_full_docs(module, function_name, app_name, keys, options, docs)

Generates docs for a variable given its module, function_name, app_name, keys to find it, options and custom docs.

gen_put_docs(module, function_name, docs)

Generates put docs for a variable given its module and function_name.

gen_reload_docs(module, function_name, docs)

Generates reload docs for a variable given its module and function_name.

gen_short_docs(module, function_name, docs)

Generates short docs for a variable given its module, function_name, and custom docs.

Types

docs()

@type docs() :: nil | false | binary()

Custom docs.

function_name()

@type function_name() :: atom()

Function name.

Functions

gen_full_docs(module, function_name, app_name, keys, options, docs)

@spec gen_full_docs(
  module(),
  function_name(),
  Skogsra.Env.app_name(),
  Skogsra.Env.keys(),
  Skogsra.Env.options(),
  docs()
) :: binary()

Generates docs for a variable given its module, function_name, app_name, keys to find it, options and custom docs.

gen_put_docs(module, function_name, docs)

@spec gen_put_docs(
  module(),
  function_name(),
  docs()
) :: binary()

Generates put docs for a variable given its module and function_name.

gen_reload_docs(module, function_name, docs)

@spec gen_reload_docs(
  module(),
  function_name(),
  docs()
) :: binary()

Generates reload docs for a variable given its module and function_name.

gen_short_docs(module, function_name, docs)

@spec gen_short_docs(
  module(),
  function_name(),
  docs()
) :: binary()

Generates short docs for a variable given its module, function_name, and custom docs.