diff options
author | Matthias Beyer <mail@beyermatthias.de> | 2016-04-27 22:22:31 +0200 |
---|---|---|
committer | Matthias Beyer <mail@beyermatthias.de> | 2016-05-04 17:33:33 +0200 |
commit | f77d6503846a35310f88d96bc373de4034429fde (patch) | |
tree | ca484eb7f464a0f7a443236f50f42c486c08030d | |
parent | 9d5912e94b5ab742b99d670057d2aa7849dc5a61 (diff) |
Document error module
-rw-r--r-- | src/error.rs | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/src/error.rs b/src/error.rs index 90c894c..2c3b372 100644 --- a/src/error.rs +++ b/src/error.rs @@ -3,9 +3,9 @@ use std::fmt::Error as FmtError; use std::clone::Clone; use std::fmt::{Display, Formatter}; -/** - * Kind of store error - */ +/// +/// Kind of task error +/// #[derive(Clone, Copy, Debug, PartialEq)] pub enum TaskErrorKind { ParserError, @@ -28,9 +28,9 @@ impl Display for TaskErrorKind { } -/** - * Store error type - */ +/// +/// Task error type +/// #[derive(Debug)] pub struct TaskError { err_type: TaskErrorKind, @@ -39,9 +39,9 @@ pub struct TaskError { impl TaskError { - /** - * Build a new TaskError from an TaskErrorKind, optionally with cause - */ + /// + /// Build a new TaskError from an TaskErrorKind, optionally with cause + /// pub fn new(errtype: TaskErrorKind, cause: Option<Box<Error>>) -> TaskError { @@ -51,9 +51,9 @@ impl TaskError { } } - /** - * Get the error type of this TaskError - */ + /// + /// Get the error type of this TaskError + /// pub fn err_type(&self) -> TaskErrorKind { self.err_type.clone() } |