O'Reilly logo

Elixir Cookbook by Paulo A Pereira

Stay ahead with the world's most comprehensive technology and business learning platform.

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, tutorials, and more.

Start Free Trial

No credit card required

Documenting modules

In this recipe, we will be using the @moduledoc and @doc reserved module attributes to add documentation to the modules we defined in the previous recipe, Enforcing behaviors.

Getting ready

Open the randomizer.ex and my_module.ex files created in the Enforcing behaviors recipe inside your preferred code editor.

How to do it…

To add documentation to our modules, follow these steps:

  1. We will start by adding module documentation to the randomizer.ex file. Add the following code below the use Behavior line:
    @moduledoc """
      This module specifies the interface for a randomizer behaviour by using the defcallback macro.
    """
  2. Add the following module documentation to the my_module.ex file below the @behaviour Randomizer line:
    @moduledoc """ This ...

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, interactive tutorials, and more.

Start Free Trial

No credit card required