first of many small code documentation

Signed-off-by: strawberry <strawberry@puppygock.gay>

src/api/client_server/media.rs

@@ -9,9 +9,10 @@ use ruma::api::client::{
     },
 };
 
+/// generated MXC ID (`media-id`) length
 const MXC_LENGTH: usize = 32;
 
-/// # `GET /_matrix/media/r0/config`
+/// # `GET /_matrix/media/v3/config`
 ///
 /// Returns max upload size.
 pub async fn get_media_config_route(
@@ -22,7 +23,7 @@ pub async fn get_media_config_route(
     })
 }
 
-/// # `POST /_matrix/media/r0/upload`
+/// # `POST /_matrix/media/v3/upload`
 ///
 /// Permanently save media in the server.
 ///
@@ -58,6 +59,7 @@ pub async fn create_content_route(
     })
 }
 
+/// helper method to fetch remote media from other servers over federation
 pub async fn get_remote_content(
     mxc: &str,
     server_name: &ruma::ServerName,

src/api/client_server/mod.rs

@@ -68,7 +68,14 @@ pub use unversioned::*;
 pub use user_directory::*;
 pub use voip::*;
 
+/// generated device ID length
 pub const DEVICE_ID_LENGTH: usize = 10;
+
+/// generated user access token length
 pub const TOKEN_LENGTH: usize = 32;
+
+/// generated user session ID length
 pub const SESSION_ID_LENGTH: usize = 32;
+
+/// auto-generated password length
 pub const AUTO_GEN_PASSWORD_LENGTH: usize = 25;

src/config/mod.rs

@@ -14,10 +14,13 @@ mod proxy;
 
 use self::proxy::ProxyConfig;
 
+/// all the config options for conduwuit
 #[derive(Clone, Debug, Deserialize)]
 pub struct Config {
+    /// [`IpAddr`] conduwuit will listen on (can be IPv4 or IPv6)
     #[serde(default = "default_address")]
     pub address: IpAddr,
+    /// default TCP port conduwuit will listen on
     #[serde(default = "default_port")]
     pub port: u16,
     pub tls: Option<TlsConfig>,