diff --git a/src/api/mod.rs b/src/api/mod.rs index 9fd954d..7329c50 100644 --- a/src/api/mod.rs +++ b/src/api/mod.rs @@ -1,3 +1,4 @@ +//! All of the API's endpoints. pub use channels::messages::*; pub use guilds::*; pub use invites::*; diff --git a/src/errors.rs b/src/errors.rs index bf08772..eebfae3 100644 --- a/src/errors.rs +++ b/src/errors.rs @@ -1,3 +1,4 @@ +//! Contains all the errors that can be returned by the library. use custom_error::custom_error; use reqwest::Error; diff --git a/src/gateway.rs b/src/gateway.rs index d3a748c..8f3392a 100644 --- a/src/gateway.rs +++ b/src/gateway.rs @@ -1,3 +1,5 @@ +//! Gateway connection, communication and handling, as well as object caching and updating. + use crate::errors::GatewayError; use crate::gateway::events::Events; use crate::types::{ diff --git a/src/instance.rs b/src/instance.rs index 7219c03..0e39a24 100644 --- a/src/instance.rs +++ b/src/instance.rs @@ -1,3 +1,5 @@ +//! Instance and ChorusUser objects. + use std::cell::RefCell; use std::collections::HashMap; use std::fmt; diff --git a/src/lib.rs b/src/lib.rs index 6563bed..1efa283 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,3 +1,7 @@ +//! A library for interacting with one or multiple Spacebar-compatible APIs and Gateways. +//! +//! # About +//!Chorus is a Rust library that allows developers to interact with multiple Spacebar-compatible APIs and Gateways simultaneously. The library provides a simple and efficient way to communicate with these services, making it easier for developers to build applications that rely on them. Chorus is open-source and welcomes contributions from the community. #![allow(clippy::module_inception)] use url::{ParseError, Url}; diff --git a/src/ratelimiter.rs b/src/ratelimiter.rs index 766e68a..5ffedb5 100644 --- a/src/ratelimiter.rs +++ b/src/ratelimiter.rs @@ -1,3 +1,5 @@ +//! Ratelimiter and request handling functionality. + use std::collections::HashMap; use log::{self, debug}; diff --git a/src/types/mod.rs b/src/types/mod.rs index 8554011..6f06ef0 100644 --- a/src/types/mod.rs +++ b/src/types/mod.rs @@ -1,3 +1,5 @@ +//! All the types, entities, events and interfaces of the Spacebar API. + pub use config::*; pub use entities::*; pub use errors::*;