View Source TypedStructNimbleOptions (typed_struct_nimble_options v0.1.0)

Merge typed_struct and nimble_options to form a documented, validated struct type.

Supported options

  • :ctor - Name of the non-bang constructor function. nil disables constructor generation. The default value is :new.

  • :ctor! - Name of the bang constructor function. nil disables bang constructor generation. The default value is :new!.

  • :docs - Name of the functions that return the NimbleOptions docs for the struct. nil disables docs functions generation. The default value is :field_docs.

  • :otp_app (atom/0) - Name of the OTP application using TypedStructNimbleOptions. This is used to fetch global options for the TypedStructNimbleOptions. Defaults to Application.get_application(__CALLER__.module).

  • :append_moduledoc_header - Whether to append the generated docs to the @moduledoc. The docs are appended with the header specified in this option. Docs are appended only if the header is not nil. The default value is "\n## Fields".

  • :warn_unknown_types? (boolean/0) - Whether to warn when an unknown type is encountered. The default value is true.

Summary

Functions

Link to this macro

after_definition()

View Source (macro)