Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

=docc Make docs use symbol references #230

Merged
merged 1 commit into from
Aug 23, 2022
Merged

=docc Make docs use symbol references #230

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 28 additions & 26 deletions Sources/Logging/Logging.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ extension Logger {
#if compiler(>=5.3)
/// Log a message passing the log level as a parameter.
///
/// If the `logLevel` passed to this method is more severe than the `Logger`'s `logLevel`, it will be logged,
/// If the `logLevel` passed to this method is more severe than the `Logger`'s ``logLevel``, it will be logged,
/// otherwise nothing will happen.
///
/// - parameters:
Expand Down Expand Up @@ -168,9 +168,9 @@ extension Logger {
}

extension Logger {
/// Log a message passing with the `Logger.Level.trace` log level.
/// Log a message passing with the ``Logger/Level/trace`` log level.
///
/// If `.trace` is at least as severe as the `Logger`'s `logLevel`, it will be logged,
/// If `.trace` is at least as severe as the `Logger`'s ``logLevel``, it will be logged,
/// otherwise nothing will happen.
///
/// - parameters:
Expand Down Expand Up @@ -205,7 +205,9 @@ extension Logger {
}
#endif

/// If `.trace` is at least as severe as the `Logger`'s `logLevel`, it will be logged,
/// Log a message passing with the ``Logger/Level/trace`` log level.
///
/// If `.trace` is at least as severe as the `Logger`'s ``logLevel``, it will be logged,
/// otherwise nothing will happen.
///
/// - parameters:
Expand Down Expand Up @@ -234,9 +236,9 @@ extension Logger {
}
#endif

/// Log a message passing with the `Logger.Level.debug` log level.
/// Log a message passing with the ``Logger/Level/debug`` log level.
///
/// If `.debug` is at least as severe as the `Logger`'s `logLevel`, it will be logged,
/// If `.debug` is at least as severe as the `Logger`'s ``logLevel``, it will be logged,
/// otherwise nothing will happen.
///
/// - parameters:
Expand Down Expand Up @@ -270,9 +272,9 @@ extension Logger {
}
#endif

/// Log a message passing with the `Logger.Level.debug` log level.
/// Log a message passing with the ``Logger/Level/debug`` log level.
///
/// If `.debug` is at least as severe as the `Logger`'s `logLevel`, it will be logged,
/// If `.debug` is at least as severe as the `Logger`'s ``logLevel``, it will be logged,
/// otherwise nothing will happen.
///
/// - parameters:
Expand Down Expand Up @@ -301,9 +303,9 @@ extension Logger {
}
#endif

/// Log a message passing with the `Logger.Level.info` log level.
/// Log a message passing with the ``Logger/Level/info`` log level.
///
/// If `.info` is at least as severe as the `Logger`'s `logLevel`, it will be logged,
/// If `.info` is at least as severe as the `Logger`'s ``logLevel``, it will be logged,
/// otherwise nothing will happen.
///
/// - parameters:
Expand Down Expand Up @@ -338,9 +340,9 @@ extension Logger {
}
#endif

/// Log a message passing with the `Logger.Level.info` log level.
/// Log a message passing with the ``Logger/Level/info`` log level.
///
/// If `.info` is at least as severe as the `Logger`'s `logLevel`, it will be logged,
/// If `.info` is at least as severe as the `Logger`'s ``logLevel``, it will be logged,
/// otherwise nothing will happen.
///
/// - parameters:
Expand Down Expand Up @@ -369,9 +371,9 @@ extension Logger {
}
#endif

/// Log a message passing with the `Logger.Level.notice` log level.
/// Log a message passing with the ``Logger/Level/notice`` log level.
///
/// If `.notice` is at least as severe as the `Logger`'s `logLevel`, it will be logged,
/// If `.notice` is at least as severe as the `Logger`'s ``logLevel``, it will be logged,
/// otherwise nothing will happen.
///
/// - parameters:
Expand Down Expand Up @@ -406,9 +408,9 @@ extension Logger {
}
#endif

/// Log a message passing with the `Logger.Level.notice` log level.
/// Log a message passing with the ``Logger/Level/notice`` log level.
///
/// If `.notice` is at least as severe as the `Logger`'s `logLevel`, it will be logged,
/// If `.notice` is at least as severe as the `Logger`'s ``logLevel``, it will be logged,
/// otherwise nothing will happen.
///
/// - parameters:
Expand Down Expand Up @@ -440,9 +442,9 @@ extension Logger {
}
#endif

/// Log a message passing with the `Logger.Level.warning` log level.
/// Log a message passing with the ``Logger/Level/warning`` log level.
///
/// If `.warning` is at least as severe as the `Logger`'s `logLevel`, it will be logged,
/// If `.warning` is at least as severe as the `Logger`'s ``logLevel``, it will be logged,
/// otherwise nothing will happen.
///
/// - parameters:
Expand Down Expand Up @@ -477,9 +479,9 @@ extension Logger {
}
#endif

/// Log a message passing with the `Logger.Level.warning` log level.
/// Log a message passing with the ``Logger/Level/warning`` log level.
///
/// If `.warning` is at least as severe as the `Logger`'s `logLevel`, it will be logged,
/// If `.warning` is at least as severe as the `Logger`'s ``logLevel``, it will be logged,
/// otherwise nothing will happen.
///
/// - parameters:
Expand Down Expand Up @@ -508,9 +510,9 @@ extension Logger {
}
#endif

/// Log a message passing with the `Logger.Level.error` log level.
/// Log a message passing with the ``Logger/Level/error`` log level.
///
/// If `.error` is at least as severe as the `Logger`'s `logLevel`, it will be logged,
/// If `.error` is at least as severe as the `Logger`'s ``logLevel``, it will be logged,
/// otherwise nothing will happen.
///
/// - parameters:
Expand Down Expand Up @@ -545,9 +547,9 @@ extension Logger {
}
#endif

/// Log a message passing with the `Logger.Level.error` log level.
/// Log a message passing with the ``Logger/Level/error`` log level.
///
/// If `.error` is at least as severe as the `Logger`'s `logLevel`, it will be logged,
/// If `.error` is at least as severe as the `Logger`'s ``logLevel``, it will be logged,
/// otherwise nothing will happen.
///
/// - parameters:
Expand Down Expand Up @@ -576,7 +578,7 @@ extension Logger {
}
#endif

/// Log a message passing with the `Logger.Level.critical` log level.
/// Log a message passing with the ``Logger/Level/critical`` log level.
///
/// `.critical` messages will always be logged.
///
Expand Down Expand Up @@ -612,7 +614,7 @@ extension Logger {
}
#endif

/// Log a message passing with the `Logger.Level.critical` log level.
/// Log a message passing with the ``Logger/Level/critical`` log level.
///
/// `.critical` messages will always be logged.
///
Expand Down