Add docs

aecsocket · Aug 16, 2024 · 9f72366 · 9f72366
1 parent 8e355ec
commit 9f72366
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/crates/aeronet_replicon/src/client.rs b/crates/aeronet_replicon/src/client.rs
@@ -39,13 +39,18 @@ use tracing::{trace, warn};
 #[derive(Derivative)]
 #[derivative(Debug(bound = ""), Clone(bound = ""), Default(bound = ""))]
 pub struct RepliconClientPlugin<T> {
+    /// Interval between when the networking loop will be updated, receiving and
+    /// flushing packets.
     pub update_interval: Duration,
     #[derivative(Debug = "ignore")]
     #[doc = "hidden"]
     pub _phantom: PhantomData<T>,
 }
 
 impl<T> RepliconClientPlugin<T> {
+    /// Creates the plugin with a given tick rate, in hertz.
+    ///
+    /// This should match the Replicon server's tick rate.
     pub fn with_tick_rate(tick_rate: u16) -> Self {
         Self {
             update_interval: Duration::from_millis(1000 / u64::from(tick_rate)),

diff --git a/crates/aeronet_replicon/src/server.rs b/crates/aeronet_replicon/src/server.rs
@@ -42,13 +42,18 @@ use tracing::{debug, warn};
 #[derive(Derivative)]
 #[derivative(Debug(bound = ""), Clone(bound = ""), Default(bound = ""))]
 pub struct RepliconServerPlugin<T> {
+    /// Interval between when the networking loop will be updated, receiving and
+    /// flushing packets.
     pub update_interval: Duration,
     #[derivative(Debug = "ignore")]
     #[doc = "hidden"]
     pub _phantom: PhantomData<T>,
 }
 
 impl<T> RepliconServerPlugin<T> {
+    /// Creates the plugin with a given tick rate, in hertz.
+    ///
+    /// This should match the Replicon server's tick rate.
     pub fn with_tick_rate(tick_rate: u16) -> Self {
         Self {
             update_interval: Duration::from_millis(1000 / u64::from(tick_rate)),