Kreuzberg.CodeDocSection (kreuzberg v4.9.5)

Copy Markdown View Source

Section within a docstring.

Fields

  • :kind - Section kind (e.g. "param", "returns", "description")
  • :name - Section name (e.g. parameter name)
  • :content - Section content text

Summary

Types

t()

Functions

from_map(data)
to_map(section)

Types

t()

@type t() :: %Kreuzberg.CodeDocSection{
  content: String.t(),
  kind: String.t(),
  name: String.t() | nil
}

Functions

from_map(data)

@spec from_map(map()) :: t()

to_map(section)

@spec to_map(t()) :: map()