From 28df1088e0a71d58dbcd3ad667f861dce6d33c0e Mon Sep 17 00:00:00 2001 From: Andre Noll Date: Sun, 8 Jun 2025 23:09:46 +0200 Subject: [PATCH] afh --- afh.h | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/afh.h b/afh.h index 1ce7fb21..21353570 100644 --- a/afh.h +++ b/afh.h @@ -3,20 +3,20 @@ /** \file afh.h Audio format handlers * * The mission of an audio format handler is to tell whether a given file - * is an audio file of a certain type. The core of the API is the \ref - * audio_format_handler structure whose methods are called when an audio - * file is added to the database of para_server(1). Also the virtual - * streaming system calls the functions here to stream a file. + * is an audio file of a certain type. The central data structure of the + * API is struct \ref audio_format_handler whose methods are called when an + * audio file is added to the database of para_server(1). Also the virtual + * streaming system calls the functions declared here. * - * More precisely, each time a file is added, the \ref - * audio_format_handler::get_file_info() method is called to initialize an \ref - * afh_info structure which contains all information needed for streaming, - * including the metadata tags. A serialized version of this structure is - * stored in the audio file table and referenced when the file is streamed. + * When an audio file is added, the \ref audio_format_handler::get_file_info() + * method is called to initialize an \ref afh_info structure which contains + * all information needed for streaming, including the metadata tags. A + * serialized version of this structure is stored in the audio file table + * and referenced when the file is opened for streaming. * * Each audio format handler is implemented in a dedicated .c file. For * example, the audio format handler for the mp3 format is \ref mp3_afh.c. All - * helper functions decribed here are implemented in \ref afh_common.c, which + * helper functions declared here are implemented in \ref afh_common.c, which * also defines the array of audio format handlers known to para_server(1), * para_afh(1) and para_recv(1). */ -- 2.39.5