Clean up misc. module doccomments
This commit is contained in:
@@ -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.
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
//! Module containing a tokenizer named [`RequestTokenizer`] for MPD requests.
|
||||
//! Tokenizer for Mpd requests named [`RequestTokenizer`].
|
||||
|
||||
use crate::commands::*;
|
||||
|
||||
|
||||
@@ -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> {
|
||||
|
||||
@@ -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;
|
||||
|
||||
Reference in New Issue
Block a user