Skip to content

Commit

Permalink
Hide deprecated items in doc
Browse files Browse the repository at this point in the history
  • Loading branch information
athre0z committed Jul 12, 2024
1 parent 374f6cd commit feb2cd0
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,7 @@ pub fn default_output_stream() -> Box<StandardStream> {
}))
}

#[doc(hidden)]
#[deprecated(
since = "0.4.0",
note = "Use `BacktracePrinter::into_panic_handler()` instead."
Expand All @@ -139,6 +140,7 @@ pub fn create_panic_handler(
})
}

#[doc(hidden)]
#[deprecated(since = "0.4.0", note = "Use `BacktracePrinter::install()` instead.")]
pub fn install_with_settings(printer: BacktracePrinter) {
std::panic::set_hook(printer.into_panic_handler(default_output_stream()))
Expand Down Expand Up @@ -499,6 +501,7 @@ impl Default for ColorScheme {
}
}

#[doc(hidden)]
#[deprecated(since = "0.4.0", note = "Use `BacktracePrinter` instead.")]
pub type Settings = BacktracePrinter;

Expand Down Expand Up @@ -815,11 +818,13 @@ impl BacktracePrinter {
// [Deprecated routines for backward compat] //
// ============================================================================================== //

#[doc(hidden)]
#[deprecated(since = "0.4.0", note = "Use `BacktracePrinter::print_trace` instead`")]
pub fn print_backtrace(trace: &backtrace::Backtrace, s: &mut BacktracePrinter) -> IOResult {
s.print_trace(trace, &mut default_output_stream())
}

#[doc(hidden)]
#[deprecated(
since = "0.4.0",
note = "Use `BacktracePrinter::print_panic_info` instead`"
Expand Down

0 comments on commit feb2cd0

Please sign in to comment.