Skogsrå v1.2.0 Skogsra.Docs View Source

This module defines the documentation generators.

Link to this section Summary

Types

Custom docs

Function name

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

Custom docs.

Link to this type

function_name() View Source
function_name() :: atom()

Function name.

Link to this section Functions

Link to this function

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

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

Link to this function

gen_put_docs(module, function_name) View Source
gen_put_docs(module(), function_name()) :: binary()

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

Link to this function

gen_reload_docs(module, function_name) View Source
gen_reload_docs(module(), function_name()) :: binary()

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

Link to this function

gen_short_docs(module, function_name, docs) View Source
gen_short_docs(module(), function_name(), docs()) :: binary()

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