]> git.tuebingen.mpg.de Git - paraslash.git/commitdiff
dox
authorAndre Noll <maan@tuebingen.mpg.de>
Tue, 27 May 2025 23:09:28 +0000 (01:09 +0200)
committerAndre Noll <maan@tuebingen.mpg.de>
Tue, 10 Jun 2025 14:04:43 +0000 (16:04 +0200)
web/documentation.in.html

index 32efe9c3b191ff2bfa6df658480e63a884e3952f..4d9aea6a09c41baf09b450d7c1124ee7becfb131 100644 (file)
 
 <h2> Source code documentation </h2>
 
+<p> The public functions and variables of the paraslash source
+code are documented in the <a href="doxygen/html/files.html">API
+Reference</a>. Suggested entry points: </p>
+
 <ul>
-       <li> <a href="doxygen/html/files.html">API Reference</a> </li>
+       <li> Executables:
+               [<a href="doxygen/html/server_8c.html">para_server</a>]
+               [<a href="doxygen/html/audiod_8c.html">para_audiod</a>]
+               [<a href="doxygen/html/play_8c.html">para_play</a>]
+               [<a href="doxygen/html/recv_8c.html">para_recv</a>]
+               [<a href="doxygen/html/filter_8c.html">para_filter</a>]
+               [<a href="doxygen/html/write_8c.html">para_write</a>]
+               [<a href="doxygen/html/client_8c.html">para_client</a>]
+               [<a href="doxygen/html/audioc_8c.html">para_audioc</a>]
+               [<a href="doxygen/html/afh_8c.html">para_afh</a>]
+               [<a href="doxygen/html/mixer_8c.html">para_mixer</a>]
+               [<a href="doxygen/html/gui_8c.html">para_gui</a>]
+       </li> <li> Subsystems:
+               [<a href="doxygen/html/sched_8h.html">Scheduler</a>]
+               [<a href="doxygen/html/buffer__tree_8h.html">Buffer Trees</a>]
+               [<a href="doxygen/html/afh_8h.html">Audio Format Handlers</a>]
+               [<a href="doxygen/html/afs_8h.html">Audio File Selector</a>]
+               [<a href="doxygen/html/vss_8h.html">Virtual Streaming System</a>]
+               [<a href="doxygen/html/send_8h.html">Senders</a>]
+               [<a href="doxygen/html/recv_8h.html">Receivers</a>]
+               [<a href="doxygen/html/filter_8h.html">Filters</a>]
+               [<a href="doxygen/html/write_8h.html">Writers</a>]
+               [<a href="doxygen/html/interactive_8h.html">Interactive Sessions</a>]
+               [<a href="doxygen/html/crypt_8h.html">Crypto API</a>]
+       </li>
 </ul>