Skip to content

Commit

Permalink
update logging category doc comments
Browse files Browse the repository at this point in the history
  • Loading branch information
Nika Hassani committed Nov 2, 2023
1 parent e59503e commit 5ab9ed7
Showing 1 changed file with 9 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -38,21 +38,27 @@ class LoggingCategory extends AmplifyCategory<LoggingPluginInterface> {
}

/// {@template amplify_core.amplify_logging_category.enable}
/// Starts recording logs emitted by [logger].
/// Starts recording logs emitted by [logger] to the local storage.
///
/// Stored logs are sent to the output periodically or on-demand.
/// To send logs to the output on-demand call `flushLogs()`.
/// {@endtemplate}
void enable() {
return defaultPlugin.enable();
}

/// {@template amplify_core.amplify_logging_category.disable}
/// Stops recording logs emitted by [logger].
/// Stops recording logs emitted by [logger] to the local storage and drop
/// logs from the local storage without sending them to the output.
/// If you want to send stored logs to the output call `flushLogs` before
/// calling `disable`.
/// {@endtemplate}
void disable() {
return defaultPlugin.disable();
}

/// {@template amplify_core.amplify_logging_category.flushLogs}
/// Sends recorded logs to an output.
/// Sends recorded logs to the output and remove them from the local storage.
/// {@endtemplate}
void flushLogs() {
return defaultPlugin.flushLogs();
Expand Down

0 comments on commit 5ab9ed7

Please sign in to comment.