Module rlx_app_info

This module represents useful, relevant information about an application.

Copyright © (C) 2012 Erlware, LLC.

Authors: Eric Merritt (ericbmerritt@gmail.com).

Description

This module represents useful, relevant information about an application. The relevant information is.

Data Types

app_type()

app_type() = project | dep | checkout | system

t()

t() = #{name := atom() | undefined, vsn := string() | undefined, applications := [atom()], included_applications := [atom()], optional_applications := [atom()], dir := file:name() | undefined, link := boolean() | undefined, app_type := app_type()}

Function Index

applications/1
dir/1
format/1
format/2
format_error/1
included_applications/1
link/1
link/2
name/1
new/5
new/6
new/7
optional_applications/1
vsn/1

Function Details

applications/1

applications(X1::t()) -> [atom()]

dir/1

dir(X1::t()) -> binary()

format/1

format(AppInfo::t()) -> iolist()

format/2

format(Indent::non_neg_integer(), X2::t()) -> iolist()

format_error/1

format_error(Reason::term()) -> iolist()

included_applications/1

included_applications(X1::t()) -> [atom()]

link/1

link(X1::t()) -> boolean()

link/2

link(AppInfo::t(), NewLink::boolean()) -> t()

name/1

name(X1::t()) -> atom()

new/5

new(Name::atom(), Vsn::string(), Dir::file:name(), Applications::[atom()], IncludedApplications::[atom()]) -> t()

new/6

new(Name::atom(), Vsn::string(), Dir::file:name(), Applications::[atom()], IncludedApplications::[atom()], OptionalApplications::[atom()] | atom()) -> t()

new/7

new(Name::atom(), Vsn::string(), Dir::file:name(), Applications::[atom()], IncludedApplications::[atom()], OptionalApplications::[atom()], AppType::app_type()) -> t()

optional_applications/1

optional_applications(X1::t()) -> [atom()]

vsn/1

vsn(X1::t()) -> string()


Generated by EDoc