docs: Add detailed descriptions to files header

Signed-off-by: Awiteb <a@4rs.nl>

crates/oxidetalis/src/database/mod.rs

@@ -14,7 +14,7 @@
 // You should have received a copy of the GNU Affero General Public License
 // along with this program. If not, see <https://gnu.org/licenses/agpl-3.0>.
 
-//! Database utilities for the OxideTalis homeserver.
+//! Database trait extensions.
 
 mod in_chat_requests;
 mod out_chat_requests;

crates/oxidetalis/src/database/user_status.rs

@@ -14,7 +14,7 @@
 // You should have received a copy of the GNU Affero General Public License
 // along with this program. If not, see <https://gnu.org/licenses/agpl-3.0>.
 
-//! Database extension to work with the whitelist table
+//! Database extension for the `users_status` table
 
 use std::num::{NonZeroU32, NonZeroU8};
 
@@ -25,7 +25,7 @@ use sea_orm::DatabaseConnection;
 
 use crate::{errors::ServerResult, websocket::errors::WsError};
 
-/// Extension trait for the `DatabaseConnection` to work with the whitelist
+/// Extension trait for the `DatabaseConnection` to work with the users status
 /// table
 pub trait UsersStatusExt {
     /// Returns true if the `whitelister` has whitelisted the

crates/oxidetalis/src/errors.rs

@@ -14,6 +14,8 @@
 // You should have received a copy of the GNU Affero General Public License
 // along with this program. If not, see <https://gnu.org/licenses/agpl-3.0>.
 
+//! Oxidetalis errors types, internal, api and websocket errors.
+
 use sea_orm::DbErr;
 
 use crate::{routes::ApiError, websocket::errors::WsError};

crates/oxidetalis/src/extensions.rs

@@ -14,6 +14,8 @@
 // You should have received a copy of the GNU Affero General Public License
 // along with this program. If not, see <https://gnu.org/licenses/agpl-3.0>.
 
+//! Global trait extensions for the Oxidetalis server.
+
 use std::sync::Arc;
 
 use chrono::Utc;

crates/oxidetalis/src/routes/errors.rs

@@ -14,6 +14,8 @@
 // You should have received a copy of the GNU Affero General Public License
 // along with this program. If not, see <https://gnu.org/licenses/agpl-3.0>.
 
+//! Oxidetalis API errors.
+
 use salvo::{
     http::StatusCode,
     oapi::{Components as OapiComponents, EndpointOutRegister, Operation as OapiOperation},

crates/oxidetalis/src/routes/mod.rs

@@ -14,6 +14,8 @@
 // You should have received a copy of the GNU Affero General Public License
 // along with this program. If not, see <https://gnu.org/licenses/agpl-3.0>.
 
+//! Oxidetalis server routes, all the routes of the server.
+
 use std::env;
 use std::sync::Arc;
 

crates/oxidetalis/src/schemas/mod.rs

@@ -14,6 +14,8 @@
 // You should have received a copy of the GNU Affero General Public License
 // along with this program. If not, see <https://gnu.org/licenses/agpl-3.0>.
 
+//! Oxidetalis api schemas.
+
 use salvo::{
     http::{header, StatusCode},
     oapi::{

crates/oxidetalis/src/schemas/user.rs

@@ -14,6 +14,8 @@
 // You should have received a copy of the GNU Affero General Public License
 // along with this program. If not, see <https://gnu.org/licenses/agpl-3.0>.
 
+//! User API schemas
+
 use std::str::FromStr;
 
 use chrono::{DateTime, Utc};

crates/oxidetalis/src/utils.rs

@@ -14,6 +14,8 @@
 // You should have received a copy of the GNU Affero General Public License
 // along with this program. If not, see <https://gnu.org/licenses/agpl-3.0>.
 
+//! Oxidetalis server utilities, utilities shared across the crate.
+
 use std::str::FromStr;
 
 use chrono::Utc;

crates/oxidetalis/src/websocket/mod.rs

@@ -14,6 +14,9 @@
 // You should have received a copy of the GNU Affero General Public License
 // along with this program. If not, see <https://gnu.org/licenses/agpl-3.0>.
 
+//! Oxidetalis WebSocket server implementation, handling the WebSocket
+//! connections.
+
 use std::{collections::HashMap, sync::Arc, time::Duration};
 
 use chrono::Utc;

crates/oxidetalis_core/src/types/cipher.rs

@@ -19,6 +19,8 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 
+//! Cipher types
+
 use std::{fmt, str::FromStr};
 
 use base58::{FromBase58, ToBase58};

crates/oxidetalis_core/src/types/impl_serde.rs

@@ -19,6 +19,8 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 
+//! Serde serialization and deserialization for types (feature `serde`)
+
 use base58::FromBase58;
 use serde::{de::Error as DeError, Deserialize, Serialize};
 

crates/oxidetalis_entities/src/incoming_chat_requests.rs

@@ -1,4 +1,4 @@
-// OxideTalis Messaging Protocol homeserver core implementation
+// OxideTalis Messaging Protocol homeserver database entities
 // Copyright (C) 2024 Awiteb <a@4rs.nl>, OxideTalis Contributors
 //
 // Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -19,6 +19,8 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 
+//! Entity for `in_chat_requests` table
+
 use chrono::Utc;
 use sea_orm::entity::prelude::*;
 

crates/oxidetalis_entities/src/lib.rs

@@ -1,4 +1,4 @@
-// OxideTalis Messaging Protocol homeserver core implementation
+// OxideTalis Messaging Protocol homeserver database entities
 // Copyright (C) 2024 Awiteb <a@4rs.nl>, OxideTalis Contributors
 //
 // Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -19,6 +19,8 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 
+#![doc = include_str!("../README.md")]
+
 pub mod incoming_chat_requests;
 pub mod outgoing_chat_requests;
 pub mod prelude;

crates/oxidetalis_entities/src/outgoing_chat_requests.rs

@@ -1,4 +1,4 @@
-// OxideTalis Messaging Protocol homeserver core implementation
+// OxideTalis Messaging Protocol homeserver database entities
 // Copyright (C) 2024 Awiteb <a@4rs.nl>, OxideTalis Contributors
 //
 // Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -19,6 +19,8 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 
+//! Entity for `out_chat_requests` table
+
 use chrono::Utc;
 use sea_orm::entity::prelude::*;
 

crates/oxidetalis_entities/src/prelude.rs

@@ -1,4 +1,4 @@
-// OxideTalis Messaging Protocol homeserver core implementation
+// OxideTalis Messaging Protocol homeserver database entities
 // Copyright (C) 2024 Awiteb <a@4rs.nl>, OxideTalis Contributors
 //
 // Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -19,6 +19,8 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 
+//! Predefined imports for the entities, all the entities are re-exported here
+
 pub use sea_orm::{
     ActiveModelTrait,
     ColumnTrait,

crates/oxidetalis_entities/src/users.rs

@@ -1,4 +1,4 @@
-// OxideTalis Messaging Protocol homeserver core implementation
+// OxideTalis Messaging Protocol homeserver database entities
 // Copyright (C) 2024 Awiteb <a@4rs.nl>, OxideTalis Contributors
 //
 // Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -19,6 +19,8 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 
+//! Entity for `users` table
+
 use sea_orm::entity::prelude::*;
 
 use crate::prelude::*;

crates/oxidetalis_entities/src/users_status.rs

@@ -1,4 +1,4 @@
-// OxideTalis Messaging Protocol homeserver core implementation
+// OxideTalis Messaging Protocol homeserver database entities
 // Copyright (C) 2024 Awiteb <a@4rs.nl>, OxideTalis Contributors
 //
 // Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -19,6 +19,8 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 
+//! Entity for `users_status` table
+
 use chrono::Utc;
 use sea_orm::entity::prelude::*;
 

crates/oxidetalis_migrations/src/create_incoming_chat_requests_table.rs

@@ -1,4 +1,4 @@
-// OxideTalis Messaging Protocol homeserver core implementation
+// OxideTalis Messaging Protocol homeserver database migrations
 // Copyright (C) 2024 Awiteb <a@4rs.nl>, OxideTalis Contributors
 //
 // Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -19,6 +19,9 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 
+//! Migration to create the `in_chat_requests` table, a table for incoming chat
+//! requests from other users
+
 use sea_orm_migration::prelude::*;
 
 use crate::create_users_table::Users;

crates/oxidetalis_migrations/src/create_outgoing_chat_requests_table.rs

@@ -1,4 +1,4 @@
-// OxideTalis Messaging Protocol homeserver core implementation
+// OxideTalis Messaging Protocol homeserver database migrations
 // Copyright (C) 2024 Awiteb <a@4rs.nl>, OxideTalis Contributors
 //
 // Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -19,6 +19,9 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 
+//! Migration to create the `out_chat_requests` table, a table for outgoing chat
+//! requests to other users
+
 use sea_orm_migration::prelude::*;
 
 use crate::create_users_table::Users;

crates/oxidetalis_migrations/src/create_users_status.rs

@@ -1,4 +1,4 @@
-// OxideTalis Messaging Protocol homeserver core implementation
+// OxideTalis Messaging Protocol homeserver database migrations
 // Copyright (C) 2024 Awiteb <a@4rs.nl>, OxideTalis Contributors
 //
 // Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -19,6 +19,9 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 
+//! Migration to create the `users_status` table, a table for storing
+//! whitelist/blacklist status of users
+
 use std::fmt;
 
 use sea_orm::sea_query::extension::postgres::Type;

crates/oxidetalis_migrations/src/create_users_table.rs

@@ -1,4 +1,4 @@
-// OxideTalis Messaging Protocol homeserver core implementation
+// OxideTalis Messaging Protocol homeserver database migrations
 // Copyright (C) 2024 Awiteb <a@4rs.nl>, OxideTalis Contributors
 //
 // Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -19,6 +19,8 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 
+//! Migration to create the `users` table, a table for storing server users.
+
 use sea_orm_migration::prelude::*;
 
 #[derive(DeriveMigrationName)]

crates/oxidetalis_migrations/src/lib.rs

@@ -1,4 +1,4 @@
-// OxideTalis Messaging Protocol homeserver core implementation
+// OxideTalis Messaging Protocol homeserver database migrations
 // Copyright (C) 2024 Awiteb <a@4rs.nl>, OxideTalis Contributors
 //
 // Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -19,6 +19,8 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 
+#![doc = include_str!("../README.md")]
+
 use sea_orm_migration::prelude::*;
 pub use sea_orm_migration::MigratorTrait;