Skip to main content

W0038 - Old EDoc Syntax

Warning​

    -module(main).
    %% @doc This is the main function documentation.
    %%<^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ warning: Old EDoc syntax
    main() ->
      dep().

    dep() -> ok.

Explanation​

The code is using EDoc style comments to describe a module or a function. Starting from OTP 27, EDoc style comments are deprecated in favour of the EEP59 syntax. Please replace the old style comment with the new syntax.

Example:

    -module(main).
    -doc "This is the main function documentation.".
    main() ->
      dep().

    dep() -> ok.