Tungsten v0.1.0 Tungsten.Codegen.Documentation View Source

Generates documentation for modules, functions and types

Link to this section Summary

Generates docs for a given Tungsten.Codegen.Command

Generates a @moduledoc for a given Tungsten.Codegen.Domain

Helper method that provides a link to relevant documentation for the given spec

generate_command_docs(command)

generate_command_docs(Tungsten.Codegen.Command.t()) :: String.t()

Generates docs for a given Tungsten.Codegen.Command

generate_domain_moduledoc(domain)

generate_domain_moduledoc(Tungsten.Codegen.Domain.t()) :: Macro.t()

Generates a @moduledoc for a given Tungsten.Codegen.Domain

generate_domain_type_typedoc(domain_type)

generate_domain_type_typedoc(Tungsten.Codegen.DomainType.t()) :: String.t()

link_to_docs(spec)

link_to_docs(
  Tungsten.Codegen.Command.t()
  | Tungsten.Codegen.Domain.t()
  | any()
) :: nil | String.t()

Helper method that provides a link to relevant documentation for the given spec