View Source ExDocJSON.ProjectNode (ExDocJSON v0.2.1)

Structure that represents a project

This struct represents the top-level information of the generated JSON.

Fields

  • about - Indicates the version of the JSON structure format.
  • name - Project name
  • version - Project version
  • description - Project summary description
  • homepage_url - Specifies the project's home page
  • language - Identifies the primary language of the documents.
  • icon - Identifies the URL of the project's logo
  • items - This JSON object contains modules, exceptions, protocols, Mix tasks, and extras details.

Summary

Types

@type t() :: %ExDocJSON.ProjectNode{
  about: String.t(),
  description: String.t(),
  homepage_url: String.t(),
  icon: String.t(),
  items: map(),
  language: String.t(),
  name: String.t(),
  version: String.t()
}