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

diff --git a/afs.h b/afs.h
index 1902995bd8088d65be1ee4c54a77342f31c23cfe..895fefa616ee0c58e8b1d855838f4c1d5409ba9f 100644 (file)
--- a/afs.h
+++ b/afs.h
@@ -299,8 +299,11 @@ int playlist_check_callback(struct afs_callback_arg *aca);
 /** evaluates to 1 if x < y, to -1 if x > y and to 0 if x == y */
 #define NUM_COMPARE(x, y) ((int)((x) < (y)) - (int)((x) > (y)))
 
-
-/** Define exported functions and a table pointer for an osl blob table. */
+/** Declare public functions and global variables of an osl blob table.
+ *
+ * This macro gets expanded four times to create symbols for the lyrics,
+ * images, moods and playlists tables.
+ */
 #define DECLARE_BLOB_SYMBOLS(table_name, cmd_prefix) \
        int cmd_prefix ## _get_name_by_id(uint32_t id, char **name); \
        int cmd_prefix ## _get_def_by_id(uint32_t id, struct osl_object *def); \
@@ -312,14 +315,14 @@ int playlist_check_callback(struct afs_callback_arg *aca);
        extern struct osl_table *table_name ## _table; \
        extern const struct afs_table_operations table_name ## _ops;
 
-/** \cond blob_symbols */
+/** \cond doyxgen_ignore */
 DECLARE_BLOB_SYMBOLS(lyrics, lyr)
 DECLARE_BLOB_SYMBOLS(images, img)
 DECLARE_BLOB_SYMBOLS(moods, mood)
 DECLARE_BLOB_SYMBOLS(playlists, pl)
-/** \endcond blob_symbols */
+/** \endcond */
 
-/** The columns of an abstract blob table. */
+/** The columns of a blob table. */
 enum blob_table_columns {
        /** The identifier, a positive integer that never repeats. */
        BLOBCOL_ID,