Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 13 additions & 4 deletions lib/ex_doc/formatter/html/autolink.ex
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ defmodule ExDoc.Formatter.HTML.Autolink do
"""
def all(modules, extension, extra_lib_dirs) do
aliases = Enum.map modules, &(&1.module)
lib_dirs = extra_lib_dirs ++ elixir_lib_dirs()
lib_dirs = extra_lib_dirs ++ elixir_lib_dirs() ++ erlang_lib_dirs()
modules
|> Enum.map(&Task.async(fn -> process_module(&1, modules, aliases, extension, lib_dirs) end))
|> Enum.map(&Task.await(&1, :infinity))
Expand Down Expand Up @@ -141,7 +141,7 @@ defmodule ExDoc.Formatter.HTML.Autolink do
Converts the given `ast` to string while linking the locals
given by `typespecs` as HTML.
"""
def typespec(ast, typespecs, aliases, lib_dirs \\ elixir_lib_dirs()) do
def typespec(ast, typespecs, aliases, lib_dirs \\ elixir_lib_dirs() ++ erlang_lib_dirs()) do
if formatter_available?() do
format_typespec(ast, typespecs, aliases, lib_dirs)
else
Expand Down Expand Up @@ -246,8 +246,7 @@ defmodule ExDoc.Formatter.HTML.Autolink do
alias = expand_alias(alias)

if source = get_source(alias, aliases, lib_dirs) do
n = enc_h("#{name}")
url = "#{source}#{enc_h(inspect alias)}.html#t:#{n}/#{length(args)}"
url = remote_url(source, alias, name, args)
string = format_typespec_form(form, url)
put_placeholder(form, string, placeholders)
else
Expand All @@ -263,6 +262,16 @@ defmodule ExDoc.Formatter.HTML.Autolink do
|> replace_placeholders(placeholders)
end

defp remote_url(@erlang_docs = source, module, name, _args) do
module = enc_h("#{module}")
name = enc_h("#{name}")
"#{source}#{module}.html#type-#{name}"
end
defp remote_url(source, alias, name, args) do
name = enc_h("#{name}")
"#{source}#{enc_h(inspect alias)}.html#t:#{name}/#{length(args)}"
end

defp format_typespec_form(form, url) do
string = Macro.to_string(form)
{string_to_link, _string_with_parens} = split_string_to_link(string)
Expand Down
11 changes: 11 additions & 0 deletions test/ex_doc/formatter/html/autolink_test.exs
Original file line number Diff line number Diff line change
Expand Up @@ -305,6 +305,17 @@ defmodule ExDoc.Formatter.HTML.AutolinkTest do
~s[<a href=\"typespecs.html#built-in-types\">term</a>()]
end

test "autolink Erlang types in typespecs" do
assert Autolink.typespec(quote(do: :sets.set()), [], []) ==
~s[<a href=\"#{@erlang_docs}sets.html#type-set\">:sets.set</a>()]

assert Autolink.typespec(quote(do: :sets.set(foo())), [], []) ==
~s[<a href=\"#{@erlang_docs}sets.html#type-set\">:sets.set</a>(foo())]

assert Autolink.typespec(quote(do: :sets.set(foo())), [foo: 0], []) ==
~s[<a href=\"#{@erlang_docs}sets.html#type-set\">:sets.set</a>(<a href=\"#t:foo/0\">foo</a>())]
end

test "autolink shared aliases in typespecs" do
assert Autolink.typespec(quote(do: Foo.t), [], [Foo]) ==
~s[<a href="Foo.html#t:t/0">Foo.t</a>()]
Expand Down
2 changes: 1 addition & 1 deletion test/ex_doc/formatter/html/templates_test.exs
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ defmodule ExDoc.Formatter.HTML.TemplatesTest do
~S[<a href="TypesAndSpecs.Sub.html#t:t/0">TypesAndSpecs.Sub.t</a>(), ] <>
~S[<a href="#t:opaque/0">opaque</a>(), :ok | :error}]

ref_html = ~s[ref() :: {:binary.part(), <a href="#t:public/1">public</a>(#{any})}]
ref_html = ~s[ref() :: {<a href="http://www.erlang.org/doc/man/binary.html#type-part">:binary.part</a>(), <a href="#t:public/1">public</a>(#{any})}]

assert content =~ ~s[<a href="#t:public/1">public(t)</a>]
refute content =~ ~s[<a href="#t:private/0">private</a>]
Expand Down