consume docs on defrecord

Author: lukaszsamson

lib/elixir_sense/core/compiler.ex

@@ -1532,6 +1532,7 @@ defmodule ElixirSense.Core.Compiler do
         :defrecordp -> :defmacrop
       end
 
+    {state, {doc, doc_meta}} = State.consume_doc_context(state)
     options = [generated: true]
 
     state =
@@ -1542,7 +1543,7 @@ defmodule ElixirSense.Core.Compiler do
         [{:\\, [], [{:args, [], nil}, []]}],
         range,
         type,
-        options
+        options |> Keyword.put(:doc, doc) |> Keyword.put(:meta, doc_meta)
       )
       |> State.add_func_to_index(
         env,
@@ -1552,7 +1553,7 @@ defmodule ElixirSense.Core.Compiler do
         type,
         options
       )
-      |> State.add_record(env, call, name, fields)
+      |> State.add_record(env, call, name, fields, doc, doc_meta)
       |> State.add_current_env_to_line(meta, env)
 
     {{{:., meta, [Record, call]}, meta, args}, state, env}

lib/elixir_sense/core/compiler/state.ex

@@ -371,10 +371,10 @@ defmodule ElixirSense.Core.Compiler.State do
     %__MODULE__{state | structs: structs}
   end
 
-  def add_record(%__MODULE__{} = state, env, type, name, fields) do
+  def add_record(%__MODULE__{} = state, env, type, name, fields, doc, meta) do
     records =
       state.records
-      |> Map.put({env.module, name}, %RecordInfo{type: type, fields: fields})
+      |> Map.put({env.module, name}, %RecordInfo{type: type, fields: fields, doc: doc, meta: meta})
 
     %__MODULE__{state | records: records}
   end
@@ -1082,7 +1082,7 @@ defmodule ElixirSense.Core.Compiler.State do
     %{state | typedoc_context: [[doc_arg | doc_context] | doc_context_rest]}
   end
 
-  defp consume_doc_context(%__MODULE__{} = state) do
+  def consume_doc_context(%__MODULE__{} = state) do
     [doc_context | doc_context_rest] = state.doc_context
     state = %{state | doc_context: [[] | doc_context_rest]}
 

lib/elixir_sense/core/state/record_info.ex

@@ -5,7 +5,9 @@ defmodule ElixirSense.Core.State.RecordInfo do
   @type field_t :: {atom, any}
   @type t :: %ElixirSense.Core.State.RecordInfo{
           type: :defrecord | :defrecordp,
-          fields: list(field_t)
+          fields: list(field_t),
+          doc: String.t(),
+          meta: map()
         }
-  defstruct type: :defrecord, fields: []
+  defstruct type: :defrecord, fields: [], doc: "", meta: %{}
 end

test/elixir_sense/core/metadata_builder_test.exs

@@ -9458,6 +9458,32 @@ defmodule ElixirSense.Core.MetadataBuilderTest do
                }
              } = state.types
     end
+
+    test "defrecord consumes doc and meta" do
+      state =
+        """
+        defmodule MyRecords do
+          import Record
+          @doc "User record"
+          @doc since: "1.0.0"
+          defrecord(:user, name: "meg", age: "25")
+        end
+        """
+        |> string_to_state
+
+      assert %ModFunInfo{
+               type: :defmacro,
+               doc: "User record",
+               meta: %{since: "1.0.0"}
+             } = state.mods_funs_to_positions[{MyRecords, :user, 1}]
+
+      assert %RecordInfo{
+               meta: %{since: "1.0.0"},
+               type: :defrecord,
+               doc: "User record",
+               fields: [name: "meg", age: "25"]
+             } = state.records[{MyRecords, :user}]
+    end
   end
 
   test "gets ExUnit imports from `use ExUnit.Case`" do