Descripex.Discoverable (descripex v0.6.0)

Copy Markdown View Source

Convenience macro that generates describe/0-2 functions closing over a module list.

Usage

defmodule MyLib do
  use Descripex.Discoverable, modules: [MyLib.Funding, MyLib.Risk]
end

MyLib.describe()                     # Level 1: library overview
MyLib.describe(:funding)             # Level 2: module functions
MyLib.describe(:funding, :annualize) # Level 3: function detail
MyLib.__descripex_modules__()        # => [MyLib.Funding, MyLib.Risk]