From eee62e0892b1247ce321cd30747ab90d58f49732 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gustav=20S=C3=B6rn=C3=A4s?= Date: Wed, 13 Jan 2021 23:19:22 +0100 Subject: document mumlib --- mumlib/src/lib.rs | 2 ++ 1 file changed, 2 insertions(+) (limited to 'mumlib/src/lib.rs') diff --git a/mumlib/src/lib.rs b/mumlib/src/lib.rs index 9b7d686..4b302e3 100644 --- a/mumlib/src/lib.rs +++ b/mumlib/src/lib.rs @@ -9,6 +9,8 @@ use colored::*; use log::*; pub const SOCKET_PATH: &str = "/tmp/mumd"; + +/// The default mumble port. pub const DEFAULT_PORT: u16 = 64738; pub fn setup_logger>(target: T, color: bool) { -- cgit v1.2.1 From ed4b641f6d4816325aa07e0f13b6132c1c4dafa2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gustav=20S=C3=B6rn=C3=A4s?= Date: Tue, 15 Jun 2021 12:50:01 +0200 Subject: more mumlib doc just because --- mumlib/src/lib.rs | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'mumlib/src/lib.rs') diff --git a/mumlib/src/lib.rs b/mumlib/src/lib.rs index 4b302e3..679db8d 100644 --- a/mumlib/src/lib.rs +++ b/mumlib/src/lib.rs @@ -1,3 +1,7 @@ +//! Shared items for crates that want to communicate with mumd and/or mumctl. + +// #![warn(missing_docs)] + pub mod command; pub mod config; pub mod error; @@ -8,11 +12,15 @@ pub use error::Error; use colored::*; use log::*; +/// The default file path to use for the socket. pub const SOCKET_PATH: &str = "/tmp/mumd"; /// The default mumble port. pub const DEFAULT_PORT: u16 = 64738; +/// Setup a minimal fern logger. +/// +/// Format: `LEVEL [yyyy-mm-dd][HH:MM:SS] FILE:LINE MESSAGE` pub fn setup_logger>(target: T, color: bool) { fern::Dispatch::new() .format(move |out, message, record| { -- cgit v1.2.1