APIDoc v0.1.3 APIDoc.Doc.Info View Source

General API information.

Example

%Info{
  name: "Example API",
  version: "0.1.3",
  description: \"""
  Example API documentation.

  Supports _markdown_.
  \"""
}

Link to this section Summary

Types

t()

General API information.

Link to this section Types

Link to this type

t() View Source
t() :: %APIDoc.Doc.Info{
  contact: APIDoc.Doc.Contact.t() | nil,
  description: String.t(),
  name: String.t(),
  version: String.t()
}

General API information.

Example

%Info{
  name: "Example API",
  version: "0.1.3",
  description: \"""
  Example API documentation.

  Supports _markdown_.
  \"""
}