Hello! I am wondering if there is somewhere a “documentation cheetsheet”? I am looking at Writing documentation — Elixir v1.20.2 but I do not see a list of all available documentation attributes. I only see this sentence “such as @moduledoc, @typedoc, and @doc” but I am not knowing which options …

Thank you hauleth! Does the above work for you? I still see no documented functions in X

I would need to check, because it have been some time since I have implemented last behaviour that required documentation in Elixir (I implement most of behaviours in Erlang).

@behaviour is documented in the documentation for Module. The rest of the attributes are documented there as well.

[image] vrod: defmodule Y do @doc """ My documentation here """ @callback something() :: keyword() end defmodule X do @behaviour Y @impl true def something() do [a: "apple"] end end You are right. It is a bug in ExDoc

@vrod , I already filed a report callbacks implementations are not listed in the module if `@impl true` · Issue #1352 · elixir-lang/ex_doc · GitHub Will look into into a submit a PR tonight if I can.

[image] eksperimental: You are right. It is a bug in ExDoc Actually, this behaviour comes from Elixir.

Thank you! I read the bug report and I think I understand what Jose has said.

Elixir Programming Language Forum

Documentation for @callback?

Questions & Help Questions

hauleth April 6, 2021, 1:49pm 2

Just @doc will work.