Add rustdoc comments
This commit is contained in:
parent
9130562790
commit
de3ccd7504
|
@ -1,3 +1,4 @@
|
||||||
|
//! All of the API's endpoints.
|
||||||
pub use channels::messages::*;
|
pub use channels::messages::*;
|
||||||
pub use guilds::*;
|
pub use guilds::*;
|
||||||
pub use invites::*;
|
pub use invites::*;
|
||||||
|
|
|
@ -1,3 +1,4 @@
|
||||||
|
//! Contains all the errors that can be returned by the library.
|
||||||
use custom_error::custom_error;
|
use custom_error::custom_error;
|
||||||
use reqwest::Error;
|
use reqwest::Error;
|
||||||
|
|
||||||
|
|
|
@ -1,3 +1,5 @@
|
||||||
|
//! Gateway connection, communication and handling, as well as object caching and updating.
|
||||||
|
|
||||||
use crate::errors::GatewayError;
|
use crate::errors::GatewayError;
|
||||||
use crate::gateway::events::Events;
|
use crate::gateway::events::Events;
|
||||||
use crate::types::{
|
use crate::types::{
|
||||||
|
|
|
@ -1,3 +1,5 @@
|
||||||
|
//! Instance and ChorusUser objects.
|
||||||
|
|
||||||
use std::cell::RefCell;
|
use std::cell::RefCell;
|
||||||
use std::collections::HashMap;
|
use std::collections::HashMap;
|
||||||
use std::fmt;
|
use std::fmt;
|
||||||
|
|
|
@ -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)]
|
#![allow(clippy::module_inception)]
|
||||||
|
|
||||||
use url::{ParseError, Url};
|
use url::{ParseError, Url};
|
||||||
|
|
|
@ -1,3 +1,5 @@
|
||||||
|
//! Ratelimiter and request handling functionality.
|
||||||
|
|
||||||
use std::collections::HashMap;
|
use std::collections::HashMap;
|
||||||
|
|
||||||
use log::{self, debug};
|
use log::{self, debug};
|
||||||
|
|
|
@ -1,3 +1,5 @@
|
||||||
|
//! All the types, entities, events and interfaces of the Spacebar API.
|
||||||
|
|
||||||
pub use config::*;
|
pub use config::*;
|
||||||
pub use entities::*;
|
pub use entities::*;
|
||||||
pub use errors::*;
|
pub use errors::*;
|
||||||
|
|
Loading…
Reference in New Issue