Skip to content

Commit 5a01fec

Browse files
committed
Swift: expand Logger doc comment
1 parent 6c932bc commit 5a01fec

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

swift/extractor/infra/log/SwiftLogging.h

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,11 @@ class Log {
151151

152152
// This class represent a named domain-specific logger, responsible for pushing logs using the
153153
// underlying `binlog::SessionWriter` class. This has a configured log level, so that logs on this
154-
// `Logger` with a level lower than the configured one are no-ops.
154+
// `Logger` with a level lower than the configured one are no-ops. The level is configured based
155+
// on rules matching `<root name>/<name>` in `CODEQL_EXTRACTOR_SWIFT_LOG_LEVELS` (see above).
156+
// `<root name>` is what is provided to the global `Log::configure`, `<name>` is provided in the
157+
// constructor. If no rule matches the name, the log level defaults to the minimum level of all
158+
// outputs.
155159
class Logger {
156160
public:
157161
explicit Logger(const std::string& name) : Logger(Log::getLoggerConfiguration(name)) {}

0 commit comments

Comments
 (0)