Module epax_com

Description
Function Index
Function Details

common functions used in epax modules.

Copyright © (C) 2012 Erlware, LLC.

Authors: Aman Mangal (mangalaman93@gmail.com).

Description

common functions used in epax modules

Function Index

abort/2	aborts the process and throws error.
abort/3	aborts the process and throws error.
console/2	prints output on terminal.
error/2	prints error on terminal.
error/3	prints error on terminal.
format/1	returns the flattened string.
format/2	returns the formatted string.
get_appfile_content/1	finds the .app or .app.src file in the application folder and returns the content of the file.
success/1	prints successful completion message on terminal.
success/2	prints successful completion message on terminal.

Function Details

abort/2

abort(Reason, Conclusion) -> ok

Reason = term()
Conclusion = string()

aborts the process and throws error

abort/3

abort(Reason, String, Args) -> ok

Reason = term()
String = string()
Args = [term()]

aborts the process and throws error

console/2

console(Message, Args) -> ok

Message = string()
Args = [term()]

prints output on terminal

error/2

error(Reason, Conclusion) -> ok

Reason = term()
Conclusion = string()

prints error on terminal

error/3

error(Reason, Conclusion, Args) -> ok

Reason = term()
Conclusion = string()
Args = [term()]

prints error on terminal

format/1

format(Deeplist) -> Result

Deeplist = [term() | Deeplist]
Result = [term()]

returns the flattened string

format/2

format(String, Args) -> Result

String = string()
Args = [term()]
Result = [char() | Result]

returns the formatted string

get_appfile_content/1

get_appfile_content(Info) -> Result

Info = atom() | string()
Result = {ok, [Content]} | {error, Reason}
Content = term()
Reason = term()

finds the .app or .app.src file in the application folder and returns the content of the file

success/1

success(Message) -> ok

Message = string()

prints successful completion message on terminal

success/2

success(Message, Args) -> ok

Message = string()
Args = [term()]

prints successful completion message on terminal

Generated by EDoc