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

Support for Elixir documentation #740

Closed
rhumbertgz opened this issue Jul 20, 2017 · 19 comments
Closed

Support for Elixir documentation #740

rhumbertgz opened this issue Jul 20, 2017 · 19 comments

Comments

@rhumbertgz
Copy link

Hello,

Could be possible to enable Elixir documentation through "Quick Documentation"?

I was trying to do it in the same way that I added the Elixir source code:
screen shot 2017-07-20 at 16 06 49
Doing this I got the autocomplete for the core-libs of Elixir, but the documentation doesn't work for me. I tried with several sources as you can see:
screen shot 2017-07-20 at 16 07 37

Any suggestion? Is there a way to do it?

Thanks in adavance,
Humberto

@KronicDeth
Copy link
Owner

I don't think using Documentation Paths would be a good idea since that's rendered HTML, but I'd have to look at how the Documentation Paths work for Java to figure out if they can consume HTML.

I would probably implement this in two features:

  1. If the source is available, then get the @doc and @moduledoc and show that.
  2. If the source is not available, then decompile the .beam and get the @doc and @moduledoc output of that and put it in the decompiled version of the .beam. This fake source will then be parsed by (1) and it will work as normal.

But yeah, if linking to hexdocs.pm worked, that would be crazy awesome too.

@rhumbertgz
Copy link
Author

@KronicDeth thanks for your fast reply!

@OvermindDL1
Copy link

But yeah, if linking to hexdocs.pm worked, that would be crazy awesome too.

This would be killer!

@smeevil
Copy link

smeevil commented Aug 22, 2017

+1

2 similar comments
@CptnKirk
Copy link

+1

@Aetherus
Copy link

+1

@Znack
Copy link

Znack commented Dec 19, 2017

+1 it should be amazingly useful

@simoneggler
Copy link

+1

5 similar comments
@Nimamoh
Copy link

Nimamoh commented Jun 6, 2018

+1

@Tsuyoshi84
Copy link

+1

@eagle-te
Copy link

+1

@dwhelan
Copy link

dwhelan commented Dec 4, 2018

+1

@IvanShpotenko
Copy link

+1

@CleytonGoncalves
Copy link

+1. Btw thanks for your amazing work!

@blakedietz
Copy link

+1. Thank you for your hard work Kronic.

@swalloda
Copy link

+1

@Timtonix
Copy link

+2

@KronicDeth
Copy link
Owner

This was added in #1792 and first released in v11.8.0 on August 4th 2020.

@KronicDeth
Copy link
Owner

@swalloda @Timtonix it was already there when you +1’d the feature.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests