Current section
Files
Jump to
Current section
Files
deps/ex_doc/lib/ex_doc/config.ex
defmodule ExDoc.Config do
@moduledoc false
@default_source_ref "master"
def default_source_ref do
@default_source_ref
end
def before_closing_head_tag(_), do: ""
def before_closing_body_tag(_), do: ""
defstruct apps: [],
api_reference: true,
assets: nil,
before_closing_head_tag: &__MODULE__.before_closing_head_tag/1,
before_closing_body_tag: &__MODULE__.before_closing_body_tag/1,
canonical: nil,
nest_modules_by_prefix: [],
deps: [],
extra_section: nil,
extras: [],
filter_prefix: nil,
formatter: "html",
groups_for_extras: [],
groups_for_modules: [],
groups_for_functions: [],
homepage_url: nil,
javascript_config_path: "docs_config.js",
language: "en",
proglang: :elixir,
logo: nil,
cover: nil,
main: nil,
output: "./doc",
project: nil,
retriever: ExDoc.Retriever,
source_beam: nil,
source_ref: @default_source_ref,
source_root: nil,
source_url: nil,
source_url_pattern: nil,
title: nil,
version: nil,
authors: nil,
skip_undefined_reference_warnings_on: []
@type t :: %__MODULE__{
apps: [atom()],
api_reference: boolean(),
assets: nil | String.t(),
before_closing_head_tag: (atom() -> String.t()),
before_closing_body_tag: (atom() -> String.t()),
canonical: nil | String.t(),
nest_modules_by_prefix: [String.t()],
deps: [{ebin_path :: String.t(), doc_url :: String.t()}],
extra_section: nil | String.t(),
extras: list(),
groups_for_extras: keyword(),
filter_prefix: nil | String.t(),
formatter: nil | String.t(),
homepage_url: nil | String.t(),
javascript_config_path: nil | String.t(),
language: String.t(),
logo: nil | Path.t(),
cover: nil | Path.t(),
main: nil | String.t(),
groups_for_modules: keyword(),
groups_for_functions: keyword((keyword() -> boolean)),
output: nil | Path.t(),
project: nil | String.t(),
retriever: :atom,
source_beam: nil | String.t(),
source_ref: nil | String.t(),
source_root: nil | String.t(),
source_url: nil | String.t(),
source_url_pattern: nil | String.t(),
title: nil | String.t(),
version: nil | String.t(),
authors: nil | [String.t()],
skip_undefined_reference_warnings_on: [String.t()]
}
end