]> git.tuebingen.mpg.de Git - paraslash.git/commitdiff
afs
authorAndre Noll <maan@tuebingen.mpg.de>
Wed, 11 Jun 2025 17:11:52 +0000 (19:11 +0200)
committerAndre Noll <maan@tuebingen.mpg.de>
Wed, 11 Jun 2025 17:11:52 +0000 (19:11 +0200)
afs.h

diff --git a/afs.h b/afs.h
index 7129af88f4c4e8bd23a9dab987c7e02cb71f6d0b..ee48e06fae432452773acc5d4aac478883a5a55a 100644 (file)
--- a/afs.h
+++ b/afs.h
@@ -1,6 +1,19 @@
 /* Copyright (C) 2007 Andre Noll <maan@tuebingen.mpg.de>, see file COPYING. */
 
-/** \file afs.h Exported symbols of the audio file selector. */
+/** \file afs.h The the audio file selector.
+ *
+ * The code of the audio file selector (afs) is distributed across several
+ * source files, which results in a rather large set of non-static functions
+ * and variables with intricate inter-dependencies.
+ *
+ * The central file is \ref afs.c, which contains the afs init and shutdown
+ * functions and the table-independent code. Other source files whose object
+ * files become part of afs are \ref attribute.c, \ref aft.c, \ref score.c,
+ * \ref mood.c, \ref playlist.c and \ref blob.c.
+ *
+ * There is only this single header file for the afs API. All non-static
+ * symbols of the source files listed above are declared here.
+ */
 
 /** Audio file selector data stored in the audio file table. */
 struct afs_info {