Fix PHPDoc comments project-wide

This commit is contained in:
Hypolite Petovan 2019-01-06 16:06:53 -05:00
parent 6077aa5847
commit 3282ce5389
113 changed files with 1703 additions and 795 deletions

View file

@ -140,13 +140,14 @@ class Logger extends BaseObject
/**
* System is unusable.
*
* @see LoggerInterface::emergency()
*
* @param string $message
* @param array $context
*
* @return void
*
* @throws \Exception
*/
public static function emergency($message, $context = [])
{
@ -170,7 +171,7 @@ class Logger extends BaseObject
* @param array $context
*
* @return void
*
* @throws \Exception
*/
public static function alert($message, $context = [])
{
@ -193,7 +194,7 @@ class Logger extends BaseObject
* @param array $context
*
* @return void
*
* @throws \Exception
*/
public static function critical($message, $context = [])
{
@ -215,7 +216,7 @@ class Logger extends BaseObject
* @param array $context
*
* @return void
*
* @throws \Exception
*/
public static function error($message, $context = [])
{
@ -240,7 +241,7 @@ class Logger extends BaseObject
* @param array $context
*
* @return void
*
* @throws \Exception
*/
public static function warning($message, $context = [])
{
@ -261,7 +262,7 @@ class Logger extends BaseObject
* @param array $context
*
* @return void
*
* @throws \Exception
*/
public static function notice($message, $context = [])
{
@ -284,7 +285,7 @@ class Logger extends BaseObject
* @param array $context
*
* @return void
*
* @throws \Exception
*/
public static function info($message, $context = [])
{
@ -305,6 +306,7 @@ class Logger extends BaseObject
* @param array $context
*
* @return void
* @throws \Exception
*/
public static function debug($message, $context = [])
{
@ -317,14 +319,15 @@ class Logger extends BaseObject
self::getApp()->saveTimestamp($stamp1, 'file');
}
/**
* @brief Logs the given message at the given log level
*
* @param string $msg
* @param int $level
/**
* @brief Logs the given message at the given log level
*
* @param string $msg
* @param string $level
*
* @throws \Exception
* @deprecated since 2019.03 Use Logger::debug() Logger::info() , ... instead
*/
*/
public static function log($msg, $level = LogLevel::NOTICE)
{
if (!isset(self::$logger)) {
@ -336,15 +339,16 @@ class Logger extends BaseObject
self::getApp()->saveTimestamp($stamp1, "file");
}
/**
* @brief An alternative logger for development.
* Works largely as log() but allows developers
* to isolate particular elements they are targetting
* personally without background noise
*
* @param string $msg
/**
* @brief An alternative logger for development.
* Works largely as log() but allows developers
* to isolate particular elements they are targetting
* personally without background noise
*
* @param string $msg
* @param string $level
*/
* @throws \Exception
*/
public static function devLog($msg, $level = LogLevel::DEBUG)
{
if (!isset(self::$logger)) {