Clean up misc. module doccomments

This commit is contained in:
2025-12-08 16:15:12 +09:00
parent 39e6b237af
commit febe651158
5 changed files with 16 additions and 10 deletions

View File

@@ -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.

View File

@@ -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

View File

@@ -1,4 +1,4 @@
//! Module containing a tokenizer named [`RequestTokenizer`] for MPD requests.
//! Tokenizer for Mpd requests named [`RequestTokenizer`].
use crate::commands::*;

View File

@@ -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> {

View File

@@ -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;