Autolink support for handling remote types in records (#1763)

elixir-lang · Sep 25, 2023 · 16a8f53 · 16a8f53
1 parent 3d85467
commit 16a8f53
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 1 deletion.
diff --git a/lib/ex_doc/language/erlang.ex b/lib/ex_doc/language/erlang.ex
@@ -583,6 +583,10 @@ defmodule ExDoc.Language.Erlang do
             {:->, _, [[{name, _, _}], {:any, _, _}]}, acc when name == :... ->
               {nil, acc}
 
+            # record{type :: remote:type/arity}
+            {:field_type, _, [name, {{:., _, [r_mod, r_type]}, _, args}]}, acc ->
+              {name, [{pp({r_mod, r_type}), {r_mod, r_type, length(args)}} | acc]}
+
             # #{x :: t()}
             {:field_type, _, [name, type]}, acc when is_atom(name) ->
               {type, acc}

diff --git a/test/ex_doc/formatter/html/erlang_test.exs b/test/ex_doc/formatter/html/erlang_test.exs
@@ -17,7 +17,7 @@ defmodule ExDoc.Formatter.HTML.ErlangTest do
     %% foo module.
     -module(foo).
     -export([foo/1, bar/0]).
-    -export_type([t/0]).
+    -export_type([t/0, t2/0]).
 
     %% @doc
     %% f/0 function.
@@ -29,6 +29,10 @@ defmodule ExDoc.Formatter.HTML.ErlangTest do
 
     -type t() :: atom().
     %% t/0 type.
+
+    -record(rec, {k1 :: any(), k2 :: any()}).
+
+    -type t2() :: #rec{k1 :: uri_string:uri_string(), k2 :: uri_string:uri_string() | undefined}.
     """)
 
     doc = generate_docs(c)
@@ -38,6 +42,12 @@ defmodule ExDoc.Formatter.HTML.ErlangTest do
 
     assert "-type t() :: atom()." =
              doc |> Floki.find("pre:fl-contains('t() :: atom().')") |> Floki.text()
+
+    assert "-type t2() :: #rec{k1 :: uri_string:uri_string(), k2 :: uri_string:uri_string() | undefined}."
+
+    doc
+    |> Floki.find("pre:fl-contains('t2() ::')")
+    |> Floki.text()
   end
 
   defp generate_docs(c) do