Merge pull request #12679 from bancer/patch-4

Improve documentation
This commit is contained in:
Mark Story 2018-10-26 18:48:52 +00:00 committed by GitHub
commit a8521aa25a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 4 deletions

View file

@ -22,7 +22,7 @@ App::uses('LogEngineCollection', 'Log');
/** /**
* Logs messages to configured Log adapters. * Logs messages to configured Log adapters.
* *
* One or more adapters * One or more adapters
* can be configured using CakeLogs's methods. * can be configured using CakeLogs's methods.
* *
@ -84,7 +84,7 @@ class CakeLog {
/** /**
* Default log levels as detailed in RFC 5424 * Default log levels as detailed in RFC 5424
* http://tools.ietf.org/html/rfc5424 * http://tools.ietf.org/html/rfc5424
* *
* Windows has fewer levels, thus notice, info and debug are the same. * Windows has fewer levels, thus notice, info and debug are the same.
* https://bugs.php.net/bug.php?id=18090 * https://bugs.php.net/bug.php?id=18090
* *
@ -398,7 +398,7 @@ class CakeLog {
* *
* @param int|string $type Type of message being written. When value is an integer * @param int|string $type Type of message being written. When value is an integer
* or a string matching the recognized levels, then it will * or a string matching the recognized levels, then it will
* be treated log levels. Otherwise it's treated as scope. * be treated as a log level. Otherwise it's treated as a scope.
* @param string $message Message content to log * @param string $message Message content to log
* @param string|array $scope The scope(s) a log message is being created in. * @param string|array $scope The scope(s) a log message is being created in.
* See CakeLog::config() for more information on logging scopes. * See CakeLog::config() for more information on logging scopes.

View file

@ -181,7 +181,9 @@ class Debugger {
* as well as export the variable using exportVar. By default the log is written to the debug log. * as well as export the variable using exportVar. By default the log is written to the debug log.
* *
* @param mixed $var Variable or content to log * @param mixed $var Variable or content to log
* @param int $level type of log to use. Defaults to LOG_DEBUG * @param int|string $level Type of log to use. Defaults to LOG_DEBUG. When value is an integer
* or a string matching the recognized levels, then it will
* be treated as a log level. Otherwise it's treated as a scope.
* @param int $depth The depth to output to. Defaults to 3. * @param int $depth The depth to output to. Defaults to 3.
* @return void * @return void
* @link https://book.cakephp.org/2.0/en/development/debugging.html#Debugger::log * @link https://book.cakephp.org/2.0/en/development/debugging.html#Debugger::log