edoc/LSP question

[Michael Truog]

On 5/22/21 12:30 AM, Olivier Boudeville wrote:
>
> Hi,
>
> I need to (ab)use the including of header files in order to define a 
> fixed set of (accessor-like) functions that shall be available from 
> within a group of modules, so that these functions can be used in such 
> modules directly (locally, i.e. without adding any module prefix when 
> calling them from these modules).
>
> The code works great but I would like the @doc documentation of these 
> functions to appear in the generated API and, more importantly, 
> through the Erlang Language Server [https://erlang-ls.github.io/], 
> which would be very useful when editing these modules.
>
> edoc detects these functions and generates HTML entries for them (iff 
> adding the {preprocess, true} option), but I never managed to have 
> their @doc comments show up there; and the LS server does not seem to 
> take them into account either.
>
Hi Olivier,

I think you may find a script like mine helpful because I believe I ran 
into a similar problem:
https://github.com/okeuday/trie/blob/master/generate_docs.sh

Best Regards,
Michael