View Source MixUnused.Meta (mix_unused v0.4.1)

Metadata of the functions

Link to this section Summary

Types

t()

Struct describing function metadata.

Link to this section Types

Specs

t() :: %MixUnused.Meta{
  doc_meta: map(),
  file: String.t(),
  line: non_neg_integer(),
  signature: String.t()
}

Struct describing function metadata.

  • :signature - stringified representation of the function call. Used for display purposes.
  • :file - path to the file that contains definition of given function.
  • :line - integer line number where the function is located within file (currently, it can point to the line where documentation is defined, not exactly to function head).
  • :doc_meta - documentation metadata of the given function.