api.md

Summary

Members	Descriptions
namespace logger	Namespace for the entire logging library.
namespace logger::detail

namespace logger

Namespace for the entire logging library.

Summary

Members	Descriptions
public void init()	Optional function to make sure Windows terminals will render colors. Colors are enabled by default, but if the environment has them completely disabled, ANSI codes will render as gibberish.
public void info(std::string & msg)	For simple messages and notifications.
public void debug(std::string & msg)	For developers to find crucial info and validate data.
public void input(std::string & msg)	For prompting the user for input. Adds '>>>' to let the user know its a pompt.
public void warning(std::string & msg)	For letting the user know about possible issues.
public void error(std::string & msg)	For showing the user system error messages that will impact functionality.
public void fatal(std::string & msg)	For alerting to an error that will completely halt the program or cause destructive behavior.

Members

public void init()

Optional function to make sure Windows terminals will render colors. Colors are enabled by default, but if the environment has them completely disabled, ANSI codes will render as gibberish.

public void info(std::string & msg)

For simple messages and notifications.

Parameters

• msg std::string to be displayed to the user.

public void debug(std::string & msg)

For developers to find crucial info and validate data.

Parameters

• msg 'std::string' to be displayed, std::to_string() works.

public void input(std::string & msg)

For prompting the user for input. Adds '>>>' to let the user know its a pompt.

Parameters

• msg std::string to be displayed to the user.

public void warning(std::string & msg)

For letting the user know about possible issues.

Parameters

• msg either an e.what() or a custom warning.

public void error(std::string & msg)

For showing the user system error messages that will impact functionality.

Parameters

• msg either an e.what() or a custom error message.

public void fatal(std::string & msg)

For alerting to an error that will completely halt the program or cause destructive behavior.

Parameters

• msg either e.what() or a custom error message.

namespace logger::detail

Summary

Members	Descriptions
public inline const char * emit(const char * code)

Members

public inline const char * emit(const char * code)

Generated by Moxygen