Gcode.Model.Comment (gcode v1.0.1)
A G-code comment.
Summary
Functions
Initialise a comment.
Types
Link to this type
error()
@type error() :: {:comment_error, String.t()}
@type t() :: %Gcode.Model.Comment{comment: String.t()}
Functions
Link to this function
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"}}