Gcode.Model.Comment (gcode v1.0.2)

Copy Markdown

A G-code comment.

Summary

Types

error()
t()

Functions

init(comment)

Initialise a comment.

Types

error()

@type error() :: {:comment_error, String.t()}

t()

@type t() :: %Gcode.Model.Comment{comment: String.t()}

Functions

init(comment)

@spec init(String.t()) :: Gcode.Result.t(t(), error())

Initialise a comment.

Example

iex> "Doc, in the carpark, with plutonium"
...> |> Comment.init()
{:ok, %Comment{comment: "Doc, in the carpark, with plutonium"}}