Skogsrå v1.2.0 Skogsra.Docs View Source
This module defines the documentation generators.
Link to this section Summary
Functions
Generates docs for a variable given its module
, function_name
,
app_name
, keys
to find it, options
and custom docs
Generates put docs for a variable given its module
and function_name
Generates reload docs for a variable given its module
and function_name
Generates short docs for a variable given its module
, function_name
,
and custom docs
Link to this section Types
docs()
View Source
docs() :: nil | binary()
docs() :: nil | binary()
Custom docs.
function_name()
View Source
function_name() :: atom()
function_name() :: atom()
Function name.
Link to this section Functions
gen_full_docs(module, function_name, app_name, keys, options, docs)
View Source
gen_full_docs(
module(),
function_name(),
Skogsra.Env.app_name(),
Skogsra.Env.keys(),
Skogsra.Env.options(),
docs()
) :: binary()
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)
View Source
gen_put_docs(module(), function_name()) :: binary()
gen_put_docs(module(), function_name()) :: binary()
Generates put docs for a variable given its module
and function_name
.
gen_reload_docs(module, function_name)
View Source
gen_reload_docs(module(), function_name()) :: binary()
gen_reload_docs(module(), function_name()) :: binary()
Generates reload docs for a variable given its module
and function_name
.
gen_short_docs(module, function_name, docs)
View Source
gen_short_docs(module(), function_name(), docs()) :: binary()
gen_short_docs(module(), function_name(), docs()) :: binary()
Generates short docs for a variable given its module
, function_name
,
and custom docs
.