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 is a custom module to demo the implementation of behaviours.
   """

3. To document the randomize function inside my_module.ex, insert the following code right above the function definition:

   @doc """
   The randomize callback defines the randomize function...