Skip to content
This repository

implement support for EDoc annotations #88

Open
domnikl opened this Issue · 2 comments

3 participants

Dominik Liebler Maxim Vladimirsky Yuri Zhloba
Dominik Liebler

When documenting Erlang source files, EDoc annotations like in the example below should be shown also in the structure view, maybe even considered for code inspection.

%% @spec (list()) -> {bar, list()}
foo(Foobar) ->
    {bar, Foobar}.

Should show up in the structures view like this:

foo/1
    foo(Foobar::list())
Maxim Vladimirsky

Tag @spec was deprecated long time ago. You should you use type specifications instead -spec. @ignatov since -spec is not yet fully supported by the plugin I would recommended to concentrate on it and leave edoc @spec for distant future when the plugin 100% implemented and you need something to get yourself busy :)

Yuri Zhloba

Yes, we should support -spec but not @spec

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.