Fix: documents

Author: RecordingTheSmile

.gitignore

@@ -1,3 +1,4 @@
 /target
 /Cargo.lock
-/tests
+/tests
+/.idea

src/job_executor.rs

@@ -7,12 +7,15 @@ use std::sync::{Arc, RwLock};
 use tokio::task::JoinHandle;
 use crate::job_storage::JobStorage;
 
-
+/// `JobExecutor` is used to execute jobs
 pub trait JobExecutor:Send + Sync{
+    /// start job execution
     fn start(&self)->JoinHandle<()>;
+    /// stop job execution and wait for all running jobs to complete
     fn stop(&self)->Pin<Box<dyn Future<Output = ()>>>;
 }
 
+/// Default implementation for `JobExecutor`
 pub struct DefaultJobExecutor<Tz: chrono::TimeZone + Send + Sync>{
     jobs: Arc<dyn JobStorage<Tz>>,
     tasks:Arc<RwLock<Vec<JoinHandle<()>>>>,

src/job_storage.rs

@@ -68,6 +68,9 @@ pub trait JobStorage<Tz: chrono::TimeZone + Send + Sync>: Send + Sync {
     async fn restore_jobs(&self) -> Result<(), SchedulerError>;
 }
 
+/// Simple Memory Job Storage implements `JobStorage`
+///
+/// !!! This JobStorage is not recommended for production environment !!!
 pub struct MemoryJobStorage<Tz = chrono::Utc>
     where Tz: chrono::TimeZone + Sync + Send
 {

src/lib.rs

@@ -1,6 +1,28 @@
+//! # TOKIO-SCHEDULER-RS
+//!
+//! Yet Another JobScheduler
+//!
+//! # Example
+//! ```rust
+//! # use tokio_scheduler_rs::job_scheduler::JobScheduler;
+//! let scheduler = JobScheduler::default_with_timezone(chrono_tz::PRC);
+//! scheduler.register_job(Box::new(HelloWorldJob)).unwrap();
+//! scheduler.add_job("HelloWorldJob".into(),"*/5 * * * * * *".into(),None).await.unwrap();
+//! scheduler.restore_jobs().await.unwrap(); // This step is used to restore job execute status.
+//!                                          // Please notice that you can implement you own job storage to store job status.
+//! scheduler.start().await.unwrap(); // `start()` returns a tokio::JoinHandle<()>, you can continue this program if you don't await it.
+//! ```
+
 pub mod job_storage;
 pub mod errors;
 pub mod job;
 pub mod job_scheduler;
 pub mod job_executor;
-pub use serde_json;
+pub use serde_json;
+pub use async_trait;
+pub use job::ScheduleJob;
+pub use job_storage::JobStorage;
+pub use job_scheduler::JobScheduler;
+pub use job_executor::JobExecutor;
+pub use job_storage::MemoryJobStorage;
+pub use job_executor::DefaultJobExecutor;