From f67183a6756beda52041534c4a8411ef05ef3b5f Mon Sep 17 00:00:00 2001 From: Andre Noll Date: Sun, 1 Jun 2025 00:19:15 +0200 Subject: [PATCH] . --- audioc.c | 25 ++++++++---- client.c | 2 +- web/documentation.in.html | 84 +++++++++++++++++++++++++-------------- web/para.css | 24 +---------- 4 files changed, 75 insertions(+), 60 deletions(-) diff --git a/audioc.c b/audioc.c index 36f9f040..4047a9e3 100644 --- a/audioc.c +++ b/audioc.c @@ -1,6 +1,16 @@ /* Copyright (C) 2005 Andre Noll , see file COPYING. */ -/** \file audioc.c The client program used to connect to para_audiod. */ +/** \file audioc.c The client program used to connect to para_audiod. + * + * The code if this file is conceptually similar to \ref client.c because + * para_audioc(1) also operates in one of three possible modes: completion + * interactive or non-interactive mode. Like the client code it calls \ref + * i9e_open() of \ref interactive.c to create an interactive session. However, + * the code to connect to the server (para_audiod(1)) is not shared with + * any other executable, so it is part of this file. + */ + +/* \cond */ #include #include @@ -13,7 +23,6 @@ #include "audiod_cmd.lsg.h" #include "audioc.lsg.h" - #include "para.h" #include "error.h" #include "lsu.h" @@ -21,7 +30,6 @@ #include "string.h" #include "fd.h" -/** Array of error strings. */ DEFINE_PARA_ERRLIST; static char *socket_name; @@ -310,21 +318,24 @@ static void handle_help_flag(void) exit(EXIT_SUCCESS); } +/** \endcond */ + /** * The client program to connect to para_audiod. * - * \param argc Usual argument count. - * \param argv Usual argument vector. + * \param argc Options are defined in the audioc lopsub suite. + * \param argv The audioc suite defines no subcommands. * * It connects to the "well-known" local socket to communicate with * para_audiod. Authentication is performed by sending a ucred buffer * containing the user id to the local socket. * - * Any data received from the socket is written to stdout. + * Any data received from the socket is written to stdout, employing the + * buffer tree subsystem. * * \return EXIT_SUCCESS or EXIT_FAILURE. * - * \sa \ref send_cred_buffer(), para_audioc(1), para_audiod(1). + * \sa \ref send_cred_buffer(), \ref stdout.c, para_audioc(1), para_audiod(1). */ int main(int argc, char *argv[]) { diff --git a/client.c b/client.c index 6f28a25b..0eec7c52 100644 --- a/client.c +++ b/client.c @@ -3,7 +3,7 @@ /** \file client.c The client program used to connect to para_server. * * The bulk of the code of this file is the completers because interactive - * sessions are implemented in \ref interactive.c and the autentication + * sessions are implemented in \ref interactive.c and the authentication * handshake (shared with para_audiod(1)) is implemented in \ref * client_common.c. This file contains no non-static functions except main(). */ diff --git a/web/documentation.in.html b/web/documentation.in.html index 9c58221f..e570c5f5 100644 --- a/web/documentation.in.html +++ b/web/documentation.in.html @@ -30,34 +30,58 @@

Source code documentation

-

The public functions and variables of the paraslash source -code are documented in the API -Reference. Suggested entry points:

+

All public functions and variables are documented, but static functions, +structures and macros defined in .c files are not. Most source files contain +additional comments not shown here which describe particular implementation +details.

- +

Subsystems

+ +

To get started in a particular subsystem, follow one of the links +below. Each link points to a header file which defines the public API of a +paraslash subsystem. This selection is not exhaustive, though.

+ +

+ [Scheduler] + [Buffer Trees] + [Audio Format Handlers] + [Virtual Streaming System] + [Audio File Selector] + [Senders] + [Receivers] + [Filters] + [Writers] + [Interactive Sessions] + [Crypto API] +

+ +

Executables

+ +

The detailed description of each executable usually mentions relevant +other object files which are linked into the executable. The comment of the +main function talks about public functions defined elsewhere and called from +this file. The comment also describes which tasks are created and registered +to the paraslash scheduler.

+ +

+ [para_server] + [para_audiod] + [para_client] + [para_audioc] + [para_afh] + [para_recv] + [para_filter] + [para_write] + [para_gui] + [para_mixer] + [para_play] +

+ +

Indices

+ +

+ [Data Structure Index] + [Enumerations] + [File List] + [Global Variables] +

diff --git a/web/para.css b/web/para.css index 5fac87bb..893aabfb 100644 --- a/web/para.css +++ b/web/para.css @@ -85,11 +85,11 @@ td.tiny { } .memitem { /* outer border around function */ - padding: 6px; + padding: 20px; background-color: #000000; border-width: 2px; border-style: solid; - border-color: #ffff00; + border-color: #333333; } .memname { @@ -102,31 +102,11 @@ td.tiny { padding-left: 10px; } -/* inner box containing function definition */ -.memproto { - background-color: #000055; - width: 100%; - border-width: 2px; - border-style: solid; - border-color: #ffff00; - font-weight: bold; -} - .paramkey { color: #ff0000; text-align: right; } -.paramtype { /* type of function parameter, e.g. "int" */ - color: #00ff00; - white-space: nowrap; -} - -.paramname { /* name of function parameter */ - color: #ffff00; - font-style: italic; -} - a.title:hover { background-color: #AA3100; } -- 2.39.5