From febe651158e67a05c97683a9ee372e5e425ebd2d Mon Sep 17 00:00:00 2001 From: h7x4 Date: Mon, 8 Dec 2025 16:15:12 +0900 Subject: [PATCH] Clean up misc. module doccomments --- src/client.rs | 5 +++-- src/commands.rs | 8 ++++---- src/request_tokenizer.rs | 2 +- src/response_tokenizer.rs | 6 ++++-- src/types.rs | 5 ++++- 5 files changed, 16 insertions(+), 10 deletions(-) diff --git a/src/client.rs b/src/client.rs index d596147f..c73e7ee5 100644 --- a/src/client.rs +++ b/src/client.rs @@ -1,5 +1,6 @@ -//! Module containing a high-level client for interacting with an MPD server. -//! It provides methods for common operations such as playing, pausing, and +//! A high-level client for interacting with an Mpd server. +//! +//! The client provides methods for common operations such as playing, pausing, and //! managing the playlist, and returns the expected response types directly //! from its methods. diff --git a/src/commands.rs b/src/commands.rs index a714bc22..2270624b 100644 --- a/src/commands.rs +++ b/src/commands.rs @@ -1,7 +1,7 @@ -//! Module containing the basic building blocks, definitions and helpers -//! for implementing an MPD command. A command consists of a pair of serializers -//! and parsers for both the request and the corresponding response, as well as -//! the command name used to identify the command. +//! The basic building blocks, definitions and helpers used to define an Mpd command. +//! +//! An mpd command consists of a pair of serializers and parsers for both the request +//! and the corresponding response, as well as the command name used to identify the command. //! //! Each command is modelled as a struct implementing the [`Command`] trait, //! which in turn uses the [`CommandRequest`] and [`CommandResponse`] traits diff --git a/src/request_tokenizer.rs b/src/request_tokenizer.rs index f531b6d0..bbd2bb89 100644 --- a/src/request_tokenizer.rs +++ b/src/request_tokenizer.rs @@ -1,4 +1,4 @@ -//! Module containing a tokenizer named [`RequestTokenizer`] for MPD requests. +//! Tokenizer for Mpd requests named [`RequestTokenizer`]. use crate::commands::*; diff --git a/src/response_tokenizer.rs b/src/response_tokenizer.rs index 604deab9..ca2b9fd1 100644 --- a/src/response_tokenizer.rs +++ b/src/response_tokenizer.rs @@ -1,5 +1,7 @@ -//! Module containing a tokenizer named [`ResponseAttributes`] for MPD responses, -//! as well as some helper macros that makes it easier to create response parsers +//! Tokenizer for Mpd responses named [`ResponseAttributes`]. +//! +//! This module also contains some helper macros that makes it easier to +//! create response parsers. #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] pub enum GenericResponseValue<'a> { diff --git a/src/types.rs b/src/types.rs index 1cb2a271..6217f5d8 100644 --- a/src/types.rs +++ b/src/types.rs @@ -1,4 +1,7 @@ -//! Common types used throughout the empidee codebase. +//! Common datatypes used in the Mpd protocol. +//! +//! This module defines various types used throughout the MPD protocol, +//! in addition to their associated serilizers and deserializers. mod absolute_relative_song_position; mod audio;