feat: Generate binary documentation

Also refactors main.rs/mod.rs to silence clippy

src/main/clap.rs

@@ -18,35 +18,35 @@ use conduwuit_core::{
 	name = conduwuit_core::name(),
 	version = conduwuit_core::version(),
 )]
-pub(crate) struct Args {
+pub struct Args {
 	#[arg(short, long)]
 	/// Path to the config TOML file (optional)
-	pub(crate) config: Option<Vec<PathBuf>>,
+	pub config: Option<Vec<PathBuf>>,
 
 	/// Override a configuration variable using TOML 'key=value' syntax
 	#[arg(long, short('O'))]
-	pub(crate) option: Vec<String>,
+	pub option: Vec<String>,
 
 	/// Run in a stricter read-only --maintenance mode.
 	#[arg(long)]
-	pub(crate) read_only: bool,
+	pub read_only: bool,
 
 	/// Run in maintenance mode while refusing connections.
 	#[arg(long)]
-	pub(crate) maintenance: bool,
+	pub maintenance: bool,
 
 	#[cfg(feature = "console")]
 	/// Activate admin command console automatically after startup.
 	#[arg(long, num_args(0))]
-	pub(crate) console: bool,
+	pub console: bool,
 
 	/// Execute console command automatically after startup.
 	#[arg(long)]
-	pub(crate) execute: Vec<String>,
+	pub execute: Vec<String>,
 
 	/// Set functional testing modes if available. Ex '--test=smoke'
 	#[arg(long, hide(true))]
-	pub(crate) test: Vec<String>,
+	pub test: Vec<String>,
 
 	/// Override the tokio worker_thread count.
 	#[arg(
@@ -55,19 +55,19 @@ pub(crate) struct Args {
 		env = "TOKIO_WORKER_THREADS",
 		default_value = available_parallelism().to_string(),
 	)]
-	pub(crate) worker_threads: usize,
+	pub worker_threads: usize,
 
 	/// Override the tokio global_queue_interval.
 	#[arg(long, hide(true), env = "TOKIO_GLOBAL_QUEUE_INTERVAL", default_value = "192")]
-	pub(crate) global_event_interval: u32,
+	pub global_event_interval: u32,
 
 	/// Override the tokio event_interval.
 	#[arg(long, hide(true), env = "TOKIO_EVENT_INTERVAL", default_value = "512")]
-	pub(crate) kernel_event_interval: u32,
+	pub kernel_event_interval: u32,
 
 	/// Override the tokio max_io_events_per_tick.
 	#[arg(long, hide(true), env = "TOKIO_MAX_IO_EVENTS_PER_TICK", default_value = "512")]
-	pub(crate) kernel_events_per_tick: usize,
+	pub kernel_events_per_tick: usize,
 
 	/// Set the histogram bucket size, in microseconds (tokio_unstable). Default
 	/// is 25 microseconds. If the values of the histogram don't approach zero
@@ -81,7 +81,7 @@ pub(crate) struct Args {
 		env = "CONDUWUIT_RUNTIME_HISTOGRAM_INTERVAL",
 		default_value = "25"
 	)]
-	pub(crate) worker_histogram_interval: u64,
+	pub worker_histogram_interval: u64,
 
 	/// Set the histogram bucket count (tokio_unstable). Default is 20.
 	#[arg(
@@ -91,7 +91,7 @@ pub(crate) struct Args {
 		env = "CONDUWUIT_RUNTIME_HISTOGRAM_BUCKETS",
 		default_value = "20"
 	)]
-	pub(crate) worker_histogram_buckets: usize,
+	pub worker_histogram_buckets: usize,
 
 	/// Toggles worker affinity feature.
 	#[arg(
@@ -105,7 +105,7 @@ pub(crate) struct Args {
 		default_value = "true",
 		default_missing_value = "true",
 	)]
-	pub(crate) worker_affinity: bool,
+	pub worker_affinity: bool,
 
 	/// Toggles feature to promote memory reclamation by the operating system
 	/// when tokio worker runs out of work.
@@ -118,7 +118,7 @@ pub(crate) struct Args {
 		num_args = 0..=1,
 		require_equals(false),
 	)]
-	pub(crate) gc_on_park: Option<bool>,
+	pub gc_on_park: Option<bool>,
 
 	/// Toggles muzzy decay for jemalloc arenas associated with a tokio
 	/// worker (when worker-affinity is enabled). Setting to false releases
@@ -134,12 +134,12 @@ pub(crate) struct Args {
 		num_args = 0..=1,
 		require_equals(false),
 	)]
-	pub(crate) gc_muzzy: Option<bool>,
+	pub gc_muzzy: Option<bool>,
 }
 
 /// Parse commandline arguments into structured data
 #[must_use]
-pub(super) fn parse() -> Args { Args::parse() }
+pub(crate) fn parse() -> Args { Args::parse() }
 
 /// Synthesize any command line options with configuration file options.
 pub(crate) fn update(mut config: Figment, args: &Args) -> Result<Figment> {