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

Commit 0657638

Browse files
committed
Add doc for generated items
1 parent 9e17aab commit 0657638

File tree

2 files changed

+3
-0
lines changed

2 files changed

+3
-0
lines changed

src/lib.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -452,6 +452,7 @@ macro_rules! error_chain {
452452
// --------------
453453

454454
quick_error! {
455+
/// The kind of an error
455456
#[derive(Debug)]
456457
pub enum $error_kind_name {
457458

@@ -528,6 +529,7 @@ macro_rules! error_chain {
528529
// The Result type
529530
// ---------------
530531

532+
/// Convenient wrapper around std::Result.
531533
pub type $result_name<T> = ::std::result::Result<T, $error_name>;
532534
};
533535

src/quick_error.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -309,6 +309,7 @@ macro_rules! quick_error {
309309
}*/
310310
#[allow(unused)]
311311
impl $name {
312+
/// A string describing the error kind.
312313
pub fn description(&self) -> &str {
313314
match *self {
314315
$(

0 commit comments

Comments
 (0)