Add module documentation

10 files changed, 20 insertions, 0 deletions

diff --git a/src/annotation.rs b/src/annotation.rs
index 4c7c8e9..d50aca6 100644
--- a/src/annotation.rs
+++ b/src/annotation.rs
@@ -1,3 +1,5 @@
+//! Module containing types and functions for annotations of tasks
+
 use std::result::Result as RResult;
 
 use serde::Serialize;
diff --git a/src/date.rs b/src/date.rs
index 8fbbe8f..8fb8602 100644
--- a/src/date.rs
+++ b/src/date.rs
@@ -1,3 +1,5 @@
+//! Module for wrapping chrono::naive::datetime::NaiveDateTime
+
 use std::error::Error;
 
 use serde::Serialize;
diff --git a/src/error.rs b/src/error.rs
index 2c3b372..7be479b 100644
--- a/src/error.rs
+++ b/src/error.rs
@@ -1,3 +1,5 @@
+//! Error module, containing error types
+
 use std::error::Error;
 use std::fmt::Error as FmtError;
 use std::clone::Clone;
diff --git a/src/import.rs b/src/import.rs
index f18ac0d..be4760c 100644
--- a/src/import.rs
+++ b/src/import.rs
@@ -1,3 +1,5 @@
+//! Module containing the `import()` function
+
 use std::io::Read;
 
 use serde_json;
diff --git a/src/priority.rs b/src/priority.rs
index 1fea41f..b9fea85 100644
--- a/src/priority.rs
+++ b/src/priority.rs
@@ -1,3 +1,5 @@
+//! Module containing TaskPriority types and trait impls
+
 use serde::Serialize;
 use serde::ser::Serializer;
 use serde::de::Deserialize;
diff --git a/src/project.rs b/src/project.rs
index 0a4cf33..1bebbeb 100644
--- a/src/project.rs
+++ b/src/project.rs
@@ -1,3 +1,5 @@
+//! Module containing `Project` type
+
 /// Typedef for Project type.
 pub type Project = String;
 
diff --git a/src/result.rs b/src/result.rs
index db95026..e28b678 100644
--- a/src/result.rs
+++ b/src/result.rs
@@ -1,3 +1,5 @@
+//! Module containing `Result` type
+
 use std::result::Result as RResult;
 
 use error::TaskError;
diff --git a/src/status.rs b/src/status.rs
index fe81134..b8ea068 100644
--- a/src/status.rs
+++ b/src/status.rs
@@ -1,3 +1,5 @@
+//! Module containing `TaskStatus` type and trait impls
+
 use serde::Serialize;
 use serde::Serializer;
 use serde::Deserialize;
diff --git a/src/tag.rs b/src/tag.rs
index 7b7b2fd..1c8ae82 100644
--- a/src/tag.rs
+++ b/src/tag.rs
@@ -1,2 +1,4 @@
+//! Module containing `Tag` type
+
 /// type definition for tags
 pub type Tag = String;
diff --git a/src/task.rs b/src/task.rs
index 3e3de39..371078d 100644
--- a/src/task.rs
+++ b/src/task.rs
@@ -1,3 +1,5 @@
+//! Module containing `Task` type as well as trait implementations
+
 use std::result::Result as RResult;
 
 use serde::Serialize;