Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

implement support for EDoc annotations #88

Closed
domnikl opened this issue Sep 23, 2012 · 2 comments
Closed

implement support for EDoc annotations #88

domnikl opened this issue Sep 23, 2012 · 2 comments
Labels
Enhancement Ticket describes a possible improvement prio:Medium

Comments

@domnikl
Copy link

domnikl commented Sep 23, 2012

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())
@horkhe
Copy link
Contributor

horkhe commented Oct 2, 2012

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 :)

@yzh44yzh
Copy link

Yes, we should support -spec but not @SPEC

@domnikl domnikl closed this as completed Oct 21, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement Ticket describes a possible improvement prio:Medium
Projects
None yet
Development

No branches or pull requests

3 participants