docs: address minor documentation cleanup

Author: enigbe

src/builder.rs

@@ -348,7 +348,7 @@ impl NodeBuilder {
 		self
 	}
 
-	/// Configures the [`Node`] instance to write logs to the provided custom log writer.
+	/// Configures the [`Node`] instance to write logs to the provided custom [`LogWriter`].
 	pub fn set_custom_logger(&mut self, log_writer: Arc<dyn LogWriter>) -> &mut Self {
 		self.log_writer_config = Some(LogWriterConfig::Custom(log_writer));
 		self
@@ -655,20 +655,23 @@ impl ArcedNodeBuilder {
 		self.inner.write().unwrap().set_storage_dir_path(storage_dir_path);
 	}
 
-	/// Configures the [`Node`] instance to write logs to the filesystem with an optional
-	/// `file_path` and `log_level` arguments.
+	/// Configures the [`Node`] instance to write logs to the filesystem.
+	///
+	/// The `log_file_path` defaults to the [`DEFAULT_LOG_FILENAME`] in the default
+	/// storage directory if set to None.
+	/// The `log_level` defaults to [`DEFAULT_LOG_LEVEL`] if set to None.
 	pub fn set_filesystem_logger(
 		&self, log_file_path: Option<String>, log_level: Option<LogLevel>,
 	) {
 		self.inner.write().unwrap().set_filesystem_logger(log_file_path, log_level);
 	}
 
-	/// Configures the [`Node`] instance to write logs to the `log` facade.
+	/// Configures the [`Node`] instance to write logs to the [`log`](https://crates.io/crates/log) facade.
 	pub fn set_log_facade_logger(&self, log_level: LogLevel) {
 		self.inner.write().unwrap().set_log_facade_logger(log_level);
 	}
 
-	/// Configures the [`Node`] instance to write logs to the provided custom log writer.
+	/// Configures the [`Node`] instance to write logs to the provided custom [`LogWriter`].
 	pub fn set_custom_logger(&self, log_writer: Arc<dyn LogWriter>) {
 		self.inner.write().unwrap().set_custom_logger(log_writer);
 	}
@@ -1298,7 +1301,7 @@ fn build_with_store_internal(
 /// Sets up the node logger.
 ///
 /// If `log_writer_conf` is set to None, uses [`LogWriterConfig::default()`].
-/// The `node_conf`is provided to access the configured storage directory.
+/// The `node_conf` is provided to access the configured storage directory.
 fn setup_logger(
 	log_writer_conf: &Option<LogWriterConfig>, node_conf: &Config,
 ) -> Result<Arc<Logger>, BuildError> {

src/logger.rs

@@ -22,8 +22,8 @@ use std::io::Write;
 use std::path::Path;
 use std::sync::Arc;
 
-/// A unit of logging output with Metadata to enable filtering module_path,
-/// file, line to inform on log's source.
+/// A unit of logging output with metadata to enable filtering `module_path`,
+/// `file`, and `line` to inform on log's source.
 #[cfg(not(feature = "uniffi"))]
 pub struct LogRecord<'a> {
 	/// The verbosity level of the message.
@@ -36,6 +36,12 @@ pub struct LogRecord<'a> {
 	pub line: u32,
 }
 
+/// A unit of logging output with metadata to enable filtering `module_path`,
+/// `file`, and `line` to inform on log's source.
+///
+/// This version is used when the `uniffi` feature is enabled.
+/// It is similar to the non-`uniffi` version, but it omits the lifetime parameter
+/// for the `LogRecord`, as the Uniffi-exposed interface cannot handle lifetimes.
 #[cfg(feature = "uniffi")]
 pub struct LogRecord {
 	/// The verbosity level of the message.
@@ -85,6 +91,9 @@ pub trait LogWriter: Send + Sync {
 
 /// Defines the behavior required for writing log records.
 ///
+/// Implementors of this trait are responsible for handling log messages,
+/// which may involve formatting, filtering, and forwarding them to specific
+/// outputs.
 /// This version is used when the `uniffi` feature is enabled.
 /// It is similar to the non-`uniffi` version, but it omits the lifetime parameter
 /// for the `LogRecord`, as the Uniffi-exposed interface cannot handle lifetimes.