Packages
kreuzberg
4.9.3
4.10.2
4.10.1
4.10.0
4.9.9
4.9.7
4.9.5
4.9.4
4.9.3
4.9.2
4.9.1
4.8.6
4.8.5
4.8.4
4.8.3
4.8.2
4.8.1
4.8.0
4.7.4
4.7.3
4.7.2
4.7.1
4.7.0
4.6.3
4.6.2
4.6.1
4.6.0
4.5.4
4.5.3
4.5.2
4.5.1
4.4.6
4.4.5
4.4.4
4.4.3
4.4.2
4.4.1
4.4.0
4.3.8
4.3.7
4.3.6
4.3.5
4.3.4
4.3.3
4.3.2
4.3.0
4.2.15
4.2.14
4.2.13
4.2.12
4.2.11
4.2.10
4.2.9
4.2.8
4.2.7
4.2.6
4.2.5
4.2.4
4.2.3
4.2.2
4.2.1
4.2.0
4.1.2
4.1.1
4.1.0
4.0.8
4.0.7
4.0.6
4.0.4
4.0.3
4.0.2
4.0.1
4.0.0
4.0.0-rc.27
4.0.0-rc.26
High-performance document intelligence library with OCR support
Current section
Files
Jump to
Current section
Files
lib/kreuzberg/code_doc_section.ex
defmodule Kreuzberg.CodeDocSection do
@moduledoc """
Section within a docstring.
## Fields
* `:kind` - Section kind (e.g. "param", "returns", "description")
* `:name` - Section name (e.g. parameter name)
* `:content` - Section content text
"""
@type t :: %__MODULE__{
kind: String.t(),
name: String.t() | nil,
content: String.t()
}
defstruct kind: "",
name: nil,
content: ""
@spec from_map(map()) :: t()
def from_map(data) when is_map(data) do
%__MODULE__{
kind: Map.get(data, "kind", Map.get(data, :kind, "")),
name: Map.get(data, "name", Map.get(data, :name)),
content: Map.get(data, "content", Map.get(data, :content, ""))
}
end
@spec to_map(t()) :: map()
def to_map(%__MODULE__{} = section) do
%{
"kind" => section.kind,
"name" => section.name,
"content" => section.content
}
end
end