Skip to content
This repository was archived by the owner on Aug 16, 2021. It is now read-only.

Commit 238ac30

Browse files
committed
Mask implementation details from the doc.
1 parent a7fadef commit 238ac30

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

src/error_chain.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,10 @@ macro_rules! error_chain_processed {
5858
#[derive(Debug)]
5959
pub struct $error_name {
6060
/// The kind of the error.
61+
#[doc(hidden)]
6162
pub kind: $error_kind_name,
6263
/// Contains the error chain and the backtrace.
64+
#[doc(hidden)]
6365
pub state: $crate::State,
6466
}
6567

src/lib.rs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -304,11 +304,15 @@ pub fn make_backtrace() -> Option<Arc<Backtrace>> {
304304
pub trait ChainedError: error::Error + Send + 'static {
305305
/// Associated kind type.
306306
type ErrorKind;
307+
307308
/// Creates an error from it's parts.
309+
#[doc(hidden)]
308310
fn new(kind: Self::ErrorKind, state: State) -> Self;
311+
309312
/// Returns the first known backtrace, either from it's State or from one
310313
/// of the errors from `foreign_links`.
311314
#[cfg(feature = "backtrace")]
315+
#[doc(hidden)]
312316
fn extract_backtrace(e: &(error::Error + Send + 'static))
313317
-> Option<Option<Arc<Backtrace>>>;
314318
}

0 commit comments

Comments
 (0)