gleam
gleam copied to clipboard
Support EEP 48 (compiling code documentation for use in Erlang etc)
Better yet, we should support EEP 48 so that our documentation can be viewed from Erlang, Elixir, LFE, etc shells. The actual organization and storage of this information will be trivial if tedious, but the larger challenge will lie in updating the parser to retain //// and /// comments instead of discarding them.
Agreed, the parser rework will be the fiddly bit.
RE EEP 48, last I looked into this there was some suggestion of Erlang using a -doc("..."). attribute, I wonder if that is usable yet.
It appears that EDoc supports special %% @doc ... comments, alongside other more specific constructs such as %% @author ..., which it can then compile into the EEP 48-compliant "chunks".
Ah here we are, found it -> https://github.com/erlef/build-and-packaging-wg/issues/32
Sadly José's Google Doc appears to have been deleted (or else I specifically don't have access 😅) and the EEP hasn't yet been created.
Closing as we don't have a clear idea of what to do here.