Partially fix abstract Erlang types ({@type ...}) (#1787)

elixir-lang · Oct 4, 2023 · aca43d0 · aca43d0
1 parent 51d8387
commit aca43d0
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/lib/ex_doc/language/erlang.ex b/lib/ex_doc/language/erlang.ex
@@ -215,6 +215,10 @@ defmodule ExDoc.Language.Erlang do
     binary
   end
 
+  defp walk_doc({:code, _attrs, [{:a, _, _, _}], _meta} = ast, _config) do
+    ast
+  end
+
   defp walk_doc({:code, attrs, [code], meta} = ast, config) do
     {text, url} =
       case parse_autolink(code) do

diff --git a/test/ex_doc/language/erlang_test.exs b/test/ex_doc/language/erlang_test.exs
@@ -124,6 +124,21 @@ defmodule ExDoc.Language.ErlangTest do
                ~s|<a href="https://www.erlang.org/doc/man/array.html#type-array"><code>array:array()</code></a>|
     end
 
+    test "abstract types - description", c do
+      assert autolink_doc("{@type myList(X). A special kind of lists ...}", c) ==
+               ~s|<code><a href=\"#type-myList\">myList</a>(X)</code>|
+    end
+
+    test "abstract types - description+dot", c do
+      assert autolink_doc("{@type myList(X, Y).}", c) ==
+               ~s|<code><a href=\"#type-myList\">myList</a>(X, Y)</code>|
+    end
+
+    test "abstract types - no description", c do
+      assert autolink_doc("{@type myList()}", c) ==
+               ~s|<code><a href=\"#type-myList\">myList()</a></code>|
+    end
+
     test "bad module", c do
       assert ExUnit.CaptureIO.capture_io(:stderr, fn ->
                assert autolink_doc("{@link bad}", c) == ~s|<code>bad</code>|