Clarity.Vertex.ModuleProvider protocol (Clarity v0.5.1)

Copy Markdown View Source

Protocol for extracting module atoms from vertices.

This protocol allows vertices to specify which module should be used when displaying module documentation.

Summary

Types

t()

All the types that implement this protocol.

Functions

Returns the module atom associated with this vertex, or nil if no module exists.

Types

t()

@type t() :: term()

All the types that implement this protocol.

Functions

module(vertex)

@spec module(t()) :: module() | nil

Returns the module atom associated with this vertex, or nil if no module exists.