aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJaroslav Kysela <perex@perex.cz>2001-04-24 13:02:58 +0000
committerJaroslav Kysela <perex@perex.cz>2001-04-24 13:02:58 +0000
commitf65b035a45c89fb52760b9e5a93a40914c16eb33 (patch)
treea0e2a7cd239105b00c06b1fc5ebccd9748d5a380
parent98ab09fb27b92f0d2dca9a4c7395c9d00a4f3117 (diff)
Improved in-source documentation (interfaces are divided into modules).
-rw-r--r--include/conf.h7
-rw-r--r--include/control.h259
-rw-r--r--include/conv.h8
-rw-r--r--include/error.h8
-rw-r--r--include/global.h7
-rw-r--r--include/input.h8
-rw-r--r--include/instr.h9
-rw-r--r--include/mixer.h16
-rw-r--r--include/output.h8
-rw-r--r--include/pcm.h54
-rw-r--r--include/rawmidi.h8
-rw-r--r--include/seq.h8
-rw-r--r--include/seq_midi_event.h9
-rw-r--r--include/seqmid.h9
-rw-r--r--include/timer.h8
-rw-r--r--src/conf.c3
-rw-r--r--src/error.c1
17 files changed, 209 insertions, 221 deletions
diff --git a/include/conf.h b/include/conf.h
index 9000785b..8b5aa2aa 100644
--- a/include/conf.h
+++ b/include/conf.h
@@ -1,3 +1,8 @@
+/**
+ * \defgroup Config Configuration Interface
+ * Configuration Interface
+ * \{
+ */
/** Config node type */
typedef enum _snd_config_type {
@@ -75,3 +80,5 @@ int snd_config_update(void);
}
#endif
+/** \} */
+
diff --git a/include/control.h b/include/control.h
index f5055ac6..d5818229 100644
--- a/include/control.h
+++ b/include/control.h
@@ -5,6 +5,12 @@
* *
****************************************************************************/
+/**
+ * \defgroup Control Control Interface
+ * The control interface.
+ * \{
+ */
+
typedef struct sndrv_aes_iec958 snd_aes_iec958_t;
/** CTL card info container */
@@ -303,82 +309,6 @@ unsigned int snd_ctl_event_elem_get_index(const snd_ctl_event_t *obj);
int snd_ctl_elem_list_alloc_space(snd_ctl_elem_list_t *obj, unsigned int entries);
void snd_ctl_elem_list_free_space(snd_ctl_elem_list_t *obj);
-#ifdef __cplusplus
-}
-#endif
-
-/*
- * Highlevel API for controls
- */
-
-/** HCTL element handle */
-typedef struct _snd_hctl_elem snd_hctl_elem_t;
-
-/** HCTL handle */
-typedef struct _snd_hctl snd_hctl_t;
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-/**
- * \brief Compare function for sorting HCTL elements
- * \param e1 First element
- * \param e2 Second element
- * \return -1 if e1 < e2, 0 if e1 == e2, 1 if e1 > e2
- */
-typedef int (*snd_hctl_compare_t)(const snd_hctl_elem_t *e1,
- const snd_hctl_elem_t *e2);
-int snd_hctl_compare_fast(const snd_hctl_elem_t *c1,
- const snd_hctl_elem_t *c2);
-/**
- * \brief HCTL callback function
- * \param hctl HCTL handle
- * \param mask event mask
- * \param elem related HCTL element (if any)
- * \return 0 on success otherwise a negative error code
- */
-typedef int (*snd_hctl_callback_t)(snd_hctl_t *hctl,
- unsigned int mask,
- snd_hctl_elem_t *elem);
-/**
- * \brief HCTL element callback function
- * \param elem HCTL element
- * \param mask event mask
- * \return 0 on success otherwise a negative error code
- */
-typedef int (*snd_hctl_elem_callback_t)(snd_hctl_elem_t *elem,
- unsigned int mask);
-
-int snd_hctl_open(snd_hctl_t **hctl, const char *name, int mode);
-int snd_hctl_close(snd_hctl_t *hctl);
-int snd_hctl_nonblock(snd_hctl_t *hctl, int nonblock);
-int snd_hctl_async(snd_hctl_t *hctl, int sig, pid_t pid);
-int snd_hctl_poll_descriptors_count(snd_hctl_t *hctl);
-int snd_hctl_poll_descriptors(snd_hctl_t *hctl, struct pollfd *pfds, unsigned int space);
-unsigned int snd_hctl_get_count(snd_hctl_t *hctl);
-int snd_hctl_set_compare(snd_hctl_t *hctl, snd_hctl_compare_t hsort);
-snd_hctl_elem_t *snd_hctl_first_elem(snd_hctl_t *hctl);
-snd_hctl_elem_t *snd_hctl_last_elem(snd_hctl_t *hctl);
-snd_hctl_elem_t *snd_hctl_find_elem(snd_hctl_t *hctl, const snd_ctl_elem_id_t *id);
-void snd_hctl_set_callback(snd_hctl_t *hctl, snd_hctl_callback_t callback);
-void snd_hctl_set_callback_private(snd_hctl_t *hctl, void *data);
-void *snd_hctl_get_callback_private(snd_hctl_t *hctl);
-int snd_hctl_load(snd_hctl_t *hctl);
-int snd_hctl_free(snd_hctl_t *hctl);
-int snd_hctl_handle_events(snd_hctl_t *hctl);
-const char *snd_hctl_name(snd_hctl_t *hctl);
-snd_ctl_type_t snd_hctl_type(snd_hctl_t *hctl);
-int snd_hctl_wait(snd_hctl_t *hctl, int timeout);
-
-snd_hctl_elem_t *snd_hctl_elem_next(snd_hctl_elem_t *elem);
-snd_hctl_elem_t *snd_hctl_elem_prev(snd_hctl_elem_t *elem);
-int snd_hctl_elem_info(snd_hctl_elem_t *elem, snd_ctl_elem_info_t * info);
-int snd_hctl_elem_read(snd_hctl_elem_t *elem, snd_ctl_elem_value_t * value);
-int snd_hctl_elem_write(snd_hctl_elem_t *elem, snd_ctl_elem_value_t * value);
-
-snd_hctl_t *snd_hctl_elem_get_hctl(snd_hctl_elem_t *elem);
-
size_t snd_ctl_elem_id_sizeof(void);
/** \hideinitializer
* \brief allocate an invalid #snd_ctl_elem_id_t using standard alloca
@@ -388,29 +318,17 @@ size_t snd_ctl_elem_id_sizeof(void);
int snd_ctl_elem_id_malloc(snd_ctl_elem_id_t **ptr);
void snd_ctl_elem_id_free(snd_ctl_elem_id_t *obj);
void snd_ctl_elem_id_copy(snd_ctl_elem_id_t *dst, const snd_ctl_elem_id_t *src);
-
unsigned int snd_ctl_elem_id_get_numid(const snd_ctl_elem_id_t *obj);
-
snd_ctl_elem_iface_t snd_ctl_elem_id_get_interface(const snd_ctl_elem_id_t *obj);
-
unsigned int snd_ctl_elem_id_get_device(const snd_ctl_elem_id_t *obj);
-
unsigned int snd_ctl_elem_id_get_subdevice(const snd_ctl_elem_id_t *obj);
-
const char *snd_ctl_elem_id_get_name(const snd_ctl_elem_id_t *obj);
-
unsigned int snd_ctl_elem_id_get_index(const snd_ctl_elem_id_t *obj);
-
void snd_ctl_elem_id_set_numid(snd_ctl_elem_id_t *obj, unsigned int val);
-
void snd_ctl_elem_id_set_interface(snd_ctl_elem_id_t *obj, snd_ctl_elem_iface_t val);
-
void snd_ctl_elem_id_set_device(snd_ctl_elem_id_t *obj, unsigned int val);
-
void snd_ctl_elem_id_set_subdevice(snd_ctl_elem_id_t *obj, unsigned int val);
-
void snd_ctl_elem_id_set_name(snd_ctl_elem_id_t *obj, const char *val);
-
void snd_ctl_elem_id_set_index(snd_ctl_elem_id_t *obj, unsigned int val);
size_t snd_ctl_card_info_sizeof(void);
@@ -422,21 +340,13 @@ size_t snd_ctl_card_info_sizeof(void);
int snd_ctl_card_info_malloc(snd_ctl_card_info_t **ptr);
void snd_ctl_card_info_free(snd_ctl_card_info_t *obj);
void snd_ctl_card_info_copy(snd_ctl_card_info_t *dst, const snd_ctl_card_info_t *src);
-
int snd_ctl_card_info_get_card(const snd_ctl_card_info_t *obj);
-
snd_card_type_t snd_ctl_card_info_get_type(const snd_ctl_card_info_t *obj);
-
const char *snd_ctl_card_info_get_id(const snd_ctl_card_info_t *obj);
-
const char *snd_ctl_card_info_get_abbreviation(const snd_ctl_card_info_t *obj);
-
const char *snd_ctl_card_info_get_name(const snd_ctl_card_info_t *obj);
-
const char *snd_ctl_card_info_get_longname(const snd_ctl_card_info_t *obj);
-
const char *snd_ctl_card_info_get_mixerid(const snd_ctl_card_info_t *obj);
-
const char *snd_ctl_card_info_get_mixername(const snd_ctl_card_info_t *obj);
size_t snd_ctl_event_sizeof(void);
@@ -448,7 +358,6 @@ size_t snd_ctl_event_sizeof(void);
int snd_ctl_event_malloc(snd_ctl_event_t **ptr);
void snd_ctl_event_free(snd_ctl_event_t *obj);
void snd_ctl_event_copy(snd_ctl_event_t *dst, const snd_ctl_event_t *src);
-
snd_ctl_event_type_t snd_ctl_event_get_type(const snd_ctl_event_t *obj);
size_t snd_ctl_elem_list_sizeof(void);
@@ -460,25 +369,15 @@ size_t snd_ctl_elem_list_sizeof(void);
int snd_ctl_elem_list_malloc(snd_ctl_elem_list_t **ptr);
void snd_ctl_elem_list_free(snd_ctl_elem_list_t *obj);
void snd_ctl_elem_list_copy(snd_ctl_elem_list_t *dst, const snd_ctl_elem_list_t *src);
-
void snd_ctl_elem_list_set_offset(snd_ctl_elem_list_t *obj, unsigned int val);
-
unsigned int snd_ctl_elem_list_get_used(const snd_ctl_elem_list_t *obj);
-
unsigned int snd_ctl_elem_list_get_count(const snd_ctl_elem_list_t *obj);
-
void snd_ctl_elem_list_get_id(const snd_ctl_elem_list_t *obj, unsigned int idx, snd_ctl_elem_id_t *ptr);
-
unsigned int snd_ctl_elem_list_get_numid(const snd_ctl_elem_list_t *obj, unsigned int idx);
-
snd_ctl_elem_iface_t snd_ctl_elem_list_get_interface(const snd_ctl_elem_list_t *obj, unsigned int idx);
-
unsigned int snd_ctl_elem_list_get_device(const snd_ctl_elem_list_t *obj, unsigned int idx);
-
unsigned int snd_ctl_elem_list_get_subdevice(const snd_ctl_elem_list_t *obj, unsigned int idx);
-
const char *snd_ctl_elem_list_get_name(const snd_ctl_elem_list_t *obj, unsigned int idx);
-
unsigned int snd_ctl_elem_list_get_index(const snd_ctl_elem_list_t *obj, unsigned int idx);
size_t snd_ctl_elem_info_sizeof(void);
@@ -490,65 +389,35 @@ size_t snd_ctl_elem_info_sizeof(void);
int snd_ctl_elem_info_malloc(snd_ctl_elem_info_t **ptr);
void snd_ctl_elem_info_free(snd_ctl_elem_info_t *obj);
void snd_ctl_elem_info_copy(snd_ctl_elem_info_t *dst, const snd_ctl_elem_info_t *src);
-
snd_ctl_elem_type_t snd_ctl_elem_info_get_type(const snd_ctl_elem_info_t *obj);
-
int snd_ctl_elem_info_is_readable(const snd_ctl_elem_info_t *obj);
-
int snd_ctl_elem_info_is_writable(const snd_ctl_elem_info_t *obj);
-
int snd_ctl_elem_info_is_volatile(const snd_ctl_elem_info_t *obj);
-
int snd_ctl_elem_info_is_inactive(const snd_ctl_elem_info_t *obj);
-
int snd_ctl_elem_info_is_locked(const snd_ctl_elem_info_t *obj);
-
int snd_ctl_elem_info_is_owner(const snd_ctl_elem_info_t *obj);
-
int snd_ctl_elem_info_is_indirect(const snd_ctl_elem_info_t *obj);
-
pid_t snd_ctl_elem_info_get_owner(const snd_ctl_elem_info_t *obj);
-
unsigned int snd_ctl_elem_info_get_count(const snd_ctl_elem_info_t *obj);
-
long snd_ctl_elem_info_get_min(const snd_ctl_elem_info_t *obj);
-
long snd_ctl_elem_info_get_max(const snd_ctl_elem_info_t *obj);
-
long snd_ctl_elem_info_get_step(const snd_ctl_elem_info_t *obj);
-
unsigned int snd_ctl_elem_info_get_items(const snd_ctl_elem_info_t *obj);
-
void snd_ctl_elem_info_set_item(snd_ctl_elem_info_t *obj, unsigned int val);
-
const char *snd_ctl_elem_info_get_item_name(const snd_ctl_elem_info_t *obj);
-
void snd_ctl_elem_info_get_id(const snd_ctl_elem_info_t *obj, snd_ctl_elem_id_t *ptr);
-
unsigned int snd_ctl_elem_info_get_numid(const snd_ctl_elem_info_t *obj);
-
snd_ctl_elem_iface_t snd_ctl_elem_info_get_interface(const snd_ctl_elem_info_t *obj);
-
unsigned int snd_ctl_elem_info_get_device(const snd_ctl_elem_info_t *obj);
-
unsigned int snd_ctl_elem_info_get_subdevice(const snd_ctl_elem_info_t *obj);
-
const char *snd_ctl_elem_info_get_name(const snd_ctl_elem_info_t *obj);
-
unsigned int snd_ctl_elem_info_get_index(const snd_ctl_elem_info_t *obj);
-
void snd_ctl_elem_info_set_id(snd_ctl_elem_info_t *obj, const snd_ctl_elem_id_t *ptr);
-
void snd_ctl_elem_info_set_numid(snd_ctl_elem_info_t *obj, unsigned int val);
-
void snd_ctl_elem_info_set_interface(snd_ctl_elem_info_t *obj, snd_ctl_elem_iface_t val);
-
void snd_ctl_elem_info_set_device(snd_ctl_elem_info_t *obj, unsigned int val);
-
void snd_ctl_elem_info_set_subdevice(snd_ctl_elem_info_t *obj, unsigned int val);
-
void snd_ctl_elem_info_set_name(snd_ctl_elem_info_t *obj, const char *val);
-
void snd_ctl_elem_info_set_index(snd_ctl_elem_info_t *obj, unsigned int val);
size_t snd_ctl_elem_value_sizeof(void);
@@ -560,78 +429,126 @@ size_t snd_ctl_elem_value_sizeof(void);
int snd_ctl_elem_value_malloc(snd_ctl_elem_value_t **ptr);
void snd_ctl_elem_value_free(snd_ctl_elem_value_t *obj);
void snd_ctl_elem_value_copy(snd_ctl_elem_value_t *dst, const snd_ctl_elem_value_t *src);
-
void snd_ctl_elem_value_get_id(const snd_ctl_elem_value_t *obj, snd_ctl_elem_id_t *ptr);
-
unsigned int snd_ctl_elem_value_get_numid(const snd_ctl_elem_value_t *obj);
-
snd_ctl_elem_iface_t snd_ctl_elem_value_get_interface(const snd_ctl_elem_value_t *obj);
-
unsigned int snd_ctl_elem_value_get_device(const snd_ctl_elem_value_t *obj);
-
unsigned int snd_ctl_elem_value_get_subdevice(const snd_ctl_elem_value_t *obj);
-
const char *snd_ctl_elem_value_get_name(const snd_ctl_elem_value_t *obj);
-
unsigned int snd_ctl_elem_value_get_index(const snd_ctl_elem_value_t *obj);
-
void snd_ctl_elem_value_set_id(snd_ctl_elem_value_t *obj, const snd_ctl_elem_id_t *ptr);
-
void snd_ctl_elem_value_set_numid(snd_ctl_elem_value_t *obj, unsigned int val);
-
void snd_ctl_elem_value_set_interface(snd_ctl_elem_value_t *obj, snd_ctl_elem_iface_t val);
-
void snd_ctl_elem_value_set_device(snd_ctl_elem_value_t *obj, unsigned int val);
-
void snd_ctl_elem_value_set_subdevice(snd_ctl_elem_value_t *obj, unsigned int val);
-
void snd_ctl_elem_value_set_name(snd_ctl_elem_value_t *obj, const char *val);
-
void snd_ctl_elem_value_set_index(snd_ctl_elem_value_t *obj, unsigned int val);
-
int snd_ctl_elem_value_get_boolean(const snd_ctl_elem_value_t *obj, unsigned int idx);
-
long snd_ctl_elem_value_get_integer(const snd_ctl_elem_value_t *obj, unsigned int idx);
-
unsigned int snd_ctl_elem_value_get_enumerated(const snd_ctl_elem_value_t *obj, unsigned int idx);
-
unsigned char snd_ctl_elem_value_get_byte(const snd_ctl_elem_value_t *obj, unsigned int idx);
-
void snd_ctl_elem_value_set_boolean(snd_ctl_elem_value_t *obj, unsigned int idx, long val);
-
void snd_ctl_elem_value_set_integer(snd_ctl_elem_value_t *obj, unsigned int idx, long val);
-
void snd_ctl_elem_value_set_enumerated(snd_ctl_elem_value_t *obj, unsigned int idx, unsigned int val);
-
void snd_ctl_elem_value_set_byte(snd_ctl_elem_value_t *obj, unsigned int idx, unsigned char val);
-
const void * snd_ctl_elem_value_get_bytes(const snd_ctl_elem_value_t *obj);
-
void snd_ctl_elem_value_get_iec958(const snd_ctl_elem_value_t *obj, snd_aes_iec958_t *ptr);
-
void snd_ctl_elem_value_set_iec958(snd_ctl_elem_value_t *obj, const snd_aes_iec958_t *ptr);
-void snd_hctl_elem_get_id(const snd_hctl_elem_t *obj, snd_ctl_elem_id_t *ptr);
+#ifdef __cplusplus
+}
+#endif
-unsigned int snd_hctl_elem_get_numid(const snd_hctl_elem_t *obj);
+/**
+ * \defgroup HControl Highlevel Control Interface
+ * \ingroup Control
+ * The highlevel control interface.
+ * \{
+ */
-snd_ctl_elem_iface_t snd_hctl_elem_get_interface(const snd_hctl_elem_t *obj);
+/** HCTL element handle */
+typedef struct _snd_hctl_elem snd_hctl_elem_t;
-unsigned int snd_hctl_elem_get_device(const snd_hctl_elem_t *obj);
+/** HCTL handle */
+typedef struct _snd_hctl snd_hctl_t;
-unsigned int snd_hctl_elem_get_subdevice(const snd_hctl_elem_t *obj);
+#ifdef __cplusplus
+extern "C" {
+#endif
-const char *snd_hctl_elem_get_name(const snd_hctl_elem_t *obj);
+/**
+ * \brief Compare function for sorting HCTL elements
+ * \param e1 First element
+ * \param e2 Second element
+ * \return -1 if e1 < e2, 0 if e1 == e2, 1 if e1 > e2
+ */
+typedef int (*snd_hctl_compare_t)(const snd_hctl_elem_t *e1,
+ const snd_hctl_elem_t *e2);
+int snd_hctl_compare_fast(const snd_hctl_elem_t *c1,
+ const snd_hctl_elem_t *c2);
+/**
+ * \brief HCTL callback function
+ * \param hctl HCTL handle
+ * \param mask event mask
+ * \param elem related HCTL element (if any)
+ * \return 0 on success otherwise a negative error code
+ */
+typedef int (*snd_hctl_callback_t)(snd_hctl_t *hctl,
+ unsigned int mask,
+ snd_hctl_elem_t *elem);
+/**
+ * \brief HCTL element callback function
+ * \param elem HCTL element
+ * \param mask event mask
+ * \return 0 on success otherwise a negative error code
+ */
+typedef int (*snd_hctl_elem_callback_t)(snd_hctl_elem_t *elem,
+ unsigned int mask);
-unsigned int snd_hctl_elem_get_index(const snd_hctl_elem_t *obj);
+int snd_hctl_open(snd_hctl_t **hctl, const char *name, int mode);
+int snd_hctl_close(snd_hctl_t *hctl);
+int snd_hctl_nonblock(snd_hctl_t *hctl, int nonblock);
+int snd_hctl_async(snd_hctl_t *hctl, int sig, pid_t pid);
+int snd_hctl_poll_descriptors_count(snd_hctl_t *hctl);
+int snd_hctl_poll_descriptors(snd_hctl_t *hctl, struct pollfd *pfds, unsigned int space);
+unsigned int snd_hctl_get_count(snd_hctl_t *hctl);
+int snd_hctl_set_compare(snd_hctl_t *hctl, snd_hctl_compare_t hsort);
+snd_hctl_elem_t *snd_hctl_first_elem(snd_hctl_t *hctl);
+snd_hctl_elem_t *snd_hctl_last_elem(snd_hctl_t *hctl);
+snd_hctl_elem_t *snd_hctl_find_elem(snd_hctl_t *hctl, const snd_ctl_elem_id_t *id);
+void snd_hctl_set_callback(snd_hctl_t *hctl, snd_hctl_callback_t callback);
+void snd_hctl_set_callback_private(snd_hctl_t *hctl, void *data);
+void *snd_hctl_get_callback_private(snd_hctl_t *hctl);
+int snd_hctl_load(snd_hctl_t *hctl);
+int snd_hctl_free(snd_hctl_t *hctl);
+int snd_hctl_handle_events(snd_hctl_t *hctl);
+const char *snd_hctl_name(snd_hctl_t *hctl);
+snd_ctl_type_t snd_hctl_type(snd_hctl_t *hctl);
+int snd_hctl_wait(snd_hctl_t *hctl, int timeout);
-void snd_hctl_elem_set_callback(snd_hctl_elem_t *obj, snd_hctl_elem_callback_t val);
+snd_hctl_elem_t *snd_hctl_elem_next(snd_hctl_elem_t *elem);
+snd_hctl_elem_t *snd_hctl_elem_prev(snd_hctl_elem_t *elem);
+int snd_hctl_elem_info(snd_hctl_elem_t *elem, snd_ctl_elem_info_t * info);
+int snd_hctl_elem_read(snd_hctl_elem_t *elem, snd_ctl_elem_value_t * value);
+int snd_hctl_elem_write(snd_hctl_elem_t *elem, snd_ctl_elem_value_t * value);
-void * snd_hctl_elem_get_callback_private(const snd_hctl_elem_t *obj);
+snd_hctl_t *snd_hctl_elem_get_hctl(snd_hctl_elem_t *elem);
+void snd_hctl_elem_get_id(const snd_hctl_elem_t *obj, snd_ctl_elem_id_t *ptr);
+unsigned int snd_hctl_elem_get_numid(const snd_hctl_elem_t *obj);
+snd_ctl_elem_iface_t snd_hctl_elem_get_interface(const snd_hctl_elem_t *obj);
+unsigned int snd_hctl_elem_get_device(const snd_hctl_elem_t *obj);
+unsigned int snd_hctl_elem_get_subdevice(const snd_hctl_elem_t *obj);
+const char *snd_hctl_elem_get_name(const snd_hctl_elem_t *obj);
+unsigned int snd_hctl_elem_get_index(const snd_hctl_elem_t *obj);
+void snd_hctl_elem_set_callback(snd_hctl_elem_t *obj, snd_hctl_elem_callback_t val);
+void * snd_hctl_elem_get_callback_private(const snd_hctl_elem_t *obj);
void snd_hctl_elem_set_callback_private(snd_hctl_elem_t *obj, void * val);
#ifdef __cplusplus
}
#endif
+/** \} */
+/** \} */
+
diff --git a/include/conv.h b/include/conv.h
index e7aa8d52..3ca7fd65 100644
--- a/include/conv.h
+++ b/include/conv.h
@@ -5,6 +5,12 @@
* *
****************************************************************************/
+/**
+ * \defgroup BConv Binary Value Conversion
+ * Binary Value Conversion
+ * \{
+ */
+
#define snd_host_to_LE_16(val) __cpu_to_le16(val)
#define snd_LE_to_host_16(val) __le16_to_cpu(val)
#define snd_host_to_LE_32(val) __cpu_to_le32(val)
@@ -14,3 +20,5 @@
#define snd_host_to_BE_32(val) __cpu_to_be32(val)
#define snd_BE_to_host_32(val) __be32_to_cpu(val)
+/** \} */
+
diff --git a/include/error.h b/include/error.h
index 0a03ac80..08c7c836 100644
--- a/include/error.h
+++ b/include/error.h
@@ -1,5 +1,7 @@
-/*
- * error.h
+/**
+ * \defgroup Error Error handling
+ * Error handling
+ * \{
*/
#define SND_ERROR_BEGIN 500000
@@ -28,3 +30,5 @@ extern int snd_lib_error_set_handler(snd_lib_error_handler_t *handler);
}
#endif
+/** \} */
+
diff --git a/include/global.h b/include/global.h
index 76a61d00..6742a7b7 100644
--- a/include/global.h
+++ b/include/global.h
@@ -1,5 +1,7 @@
-/*
+/**
+ * \defgroup Global Global defines
* Global defines
+ * \{
*/
#ifdef SNDRV_LITTLE_ENDIAN
@@ -13,3 +15,6 @@
#define snd_enum_to_int(v) (v)
#define snd_int_to_enum(v) (v)
#define snd_enum_incr(v) (++(v))
+
+/** \} */
+
diff --git a/include/input.h b/include/input.h
index 7c2d2a15..e1dd5066 100644
--- a/include/input.h
+++ b/include/input.h
@@ -1,3 +1,8 @@
+/**
+ * \defgroup Input Input Interface
+ * Input Interface
+ * \{
+ */
/** Input handle */
typedef struct _snd_input snd_input_t;
@@ -26,3 +31,6 @@ int snd_input_ungetc(snd_input_t *input, int c);
#ifdef __cplusplus
}
#endif
+
+/** \} */
+
diff --git a/include/instr.h b/include/instr.h
index c1c29315..bff722cd 100644
--- a/include/instr.h
+++ b/include/instr.h
@@ -5,6 +5,12 @@
* *
****************************************************************************/
+/**
+ * \defgroup Instrument Instrument Interface
+ * The Instrument Interface.
+ * \{
+ */
+
/* FM instrument support */
typedef void snd_instr_fm_t;
@@ -58,3 +64,6 @@ int snd_instr_iwffff_free(snd_instr_iwffff_t *iwffff);
#ifdef __cplusplus
}
#endif
+
+/** \} */
+
diff --git a/include/mixer.h b/include/mixer.h
index 42c85240..aa9785e2 100644
--- a/include/mixer.h
+++ b/include/mixer.h
@@ -5,6 +5,12 @@
* *
****************************************************************************/
+/**
+ * \defgroup Mixer Mixer Interface
+ * The mixer interface.
+ * \{
+ */
+
/** Mixer handle */
typedef struct _snd_mixer snd_mixer_t;
/** Mixer elements class handle */
@@ -75,6 +81,13 @@ int snd_mixer_class_unregister(snd_mixer_class_t *clss);
}
#endif
+/**
+ * \defgroup SimpleMixer Simple Mixer Interface
+ * \ingroup Mixer
+ * The simple mixer interface.
+ * \{
+ */
+
/* Simple (legacy) mixer elements API */
/** Mixer simple element channel identificator */
@@ -193,3 +206,6 @@ snd_mixer_elem_type_t snd_mixer_elem_get_type(const snd_mixer_elem_t *obj);
}
#endif
+/** \} */
+/** \} */
+
diff --git a/include/output.h b/include/output.h
index 94f57fba..0f334053 100644
--- a/include/output.h
+++ b/include/output.h
@@ -1,3 +1,8 @@
+/**
+ * \defgroup Output Output Interface
+ * Output Interface
+ * \{
+ */
/** Output handle */
typedef struct _snd_output snd_output_t;
@@ -27,3 +32,6 @@ int snd_output_flush(snd_output_t *output);
#ifdef __cplusplus
}
#endif
+
+/** \} */
+
diff --git a/include/pcm.h b/include/pcm.h
index 52cd738f..ec9c0797 100644
--- a/include/pcm.h
+++ b/include/pcm.h
@@ -5,6 +5,12 @@
* *
****************************************************************************/
+/**
+ * \defgroup PCM PCM Interface
+ * The PCM Interface.
+ * \{
+ */
+
/** PCM generic info container */
typedef struct _snd_pcm_info snd_pcm_info_t;
/** PCM hardware configuration space container */
@@ -485,7 +491,6 @@ u_int64_t snd_pcm_format_silence_64(snd_pcm_format_t format);
int snd_pcm_format_set_silence(snd_pcm_format_t format, void *buf, unsigned int samples);
size_t snd_pcm_access_mask_sizeof(void);
-
/** \hideinitializer
* \brief allocate an empty #snd_pcm_access_mask_t using standard alloca
* \param ptr returned pointer
@@ -494,7 +499,6 @@ size_t snd_pcm_access_mask_sizeof(void);
int snd_pcm_access_mask_malloc(snd_pcm_access_mask_t **ptr);
void snd_pcm_access_mask_free(snd_pcm_access_mask_t *obj);
void snd_pcm_access_mask_copy(snd_pcm_access_mask_t *dst, const snd_pcm_access_mask_t *src);
-
void snd_pcm_access_mask_none(snd_pcm_access_mask_t *mask);
void snd_pcm_access_mask_any(snd_pcm_access_mask_t *mask);
int snd_pcm_access_mask_test(const snd_pcm_access_mask_t *mask, snd_pcm_access_t val);
@@ -510,7 +514,6 @@ size_t snd_pcm_format_mask_sizeof(void);
int snd_pcm_format_mask_malloc(snd_pcm_format_mask_t **ptr);
void snd_pcm_format_mask_free(snd_pcm_format_mask_t *obj);
void snd_pcm_format_mask_copy(snd_pcm_format_mask_t *dst, const snd_pcm_format_mask_t *src);
-
void snd_pcm_format_mask_none(snd_pcm_format_mask_t *mask);
void snd_pcm_format_mask_any(snd_pcm_format_mask_t *mask);
int snd_pcm_format_mask_test(const snd_pcm_format_mask_t *mask, snd_pcm_format_t val);
@@ -526,7 +529,6 @@ size_t snd_pcm_subformat_mask_sizeof(void);
int snd_pcm_subformat_mask_malloc(snd_pcm_subformat_mask_t **ptr);
void snd_pcm_subformat_mask_free(snd_pcm_subformat_mask_t *obj);
void snd_pcm_subformat_mask_copy(snd_pcm_subformat_mask_t *dst, const snd_pcm_subformat_mask_t *src);
-
void snd_pcm_subformat_mask_none(snd_pcm_subformat_mask_t *mask);
void snd_pcm_subformat_mask_any(snd_pcm_subformat_mask_t *mask);
int snd_pcm_subformat_mask_test(const snd_pcm_subformat_mask_t *mask, snd_pcm_subformat_t val);
@@ -542,28 +544,24 @@ size_t snd_pcm_hw_params_sizeof(void);
int snd_pcm_hw_params_malloc(snd_pcm_hw_params_t **ptr);
void snd_pcm_hw_params_free(snd_pcm_hw_params_t *obj);
void snd_pcm_hw_params_copy(snd_pcm_hw_params_t *dst, const snd_pcm_hw_params_t *src);
-
int snd_pcm_hw_params_get_access(const snd_pcm_hw_params_t *params);
int snd_pcm_hw_params_test_access(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_access_t val);
int snd_pcm_hw_params_set_access(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_access_t val);
snd_pcm_access_t snd_pcm_hw_params_set_access_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params);
snd_pcm_access_t snd_pcm_hw_params_set_access_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params);
int snd_pcm_hw_params_set_access_mask(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_access_mask_t *mask);
-
int snd_pcm_hw_params_get_format(const snd_pcm_hw_params_t *params);
int snd_pcm_hw_params_test_format(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_format_t val);
int snd_pcm_hw_params_set_format(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_format_t val);
snd_pcm_format_t snd_pcm_hw_params_set_format_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params);
snd_pcm_format_t snd_pcm_hw_params_set_format_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params);
int snd_pcm_hw_params_set_format_mask(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_format_mask_t *mask);
-
int snd_pcm_hw_params_test_subformat(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_subformat_t val);
int snd_pcm_hw_params_get_subformat(const snd_pcm_hw_params_t *params);
int snd_pcm_hw_params_set_subformat(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_subformat_t val);
snd_pcm_subformat_t snd_pcm_hw_params_set_subformat_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params);
snd_pcm_subformat_t snd_pcm_hw_params_set_subformat_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params);
int snd_pcm_hw_params_set_subformat_mask(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_subformat_mask_t *mask);
-
int snd_pcm_hw_params_get_channels(const snd_pcm_hw_params_t *params);
unsigned int snd_pcm_hw_params_get_channels_min(const snd_pcm_hw_params_t *params);
unsigned int snd_pcm_hw_params_get_channels_max(const snd_pcm_hw_params_t *params);
@@ -575,7 +573,6 @@ int snd_pcm_hw_params_set_channels_minmax(snd_pcm_t *pcm, snd_pcm_hw_params_t *p
unsigned int snd_pcm_hw_params_set_channels_near(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val);
unsigned int snd_pcm_hw_params_set_channels_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params);
unsigned int snd_pcm_hw_params_set_channels_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params);
-
int snd_pcm_hw_params_get_rate(const snd_pcm_hw_params_t *params, int *dir);
unsigned int snd_pcm_hw_params_get_rate_min(const snd_pcm_hw_params_t *params, int *dir);
unsigned int snd_pcm_hw_params_get_rate_max(const snd_pcm_hw_params_t *params, int *dir);
@@ -587,7 +584,6 @@ int snd_pcm_hw_params_set_rate_minmax(snd_pcm_t *pcm, snd_pcm_hw_params_t *param
unsigned int snd_pcm_hw_params_set_rate_near(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int *dir);
unsigned int snd_pcm_hw_params_set_rate_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, int *dir);
unsigned int snd_pcm_hw_params_set_rate_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, int *dir);
-
int snd_pcm_hw_params_get_period_time(const snd_pcm_hw_params_t *params, int *dir);
unsigned int snd_pcm_hw_params_get_period_time_min(const snd_pcm_hw_params_t *params, int *dir);
unsigned int snd_pcm_hw_params_get_period_time_max(const snd_pcm_hw_params_t *params, int *dir);
@@ -599,7 +595,6 @@ int snd_pcm_hw_params_set_period_time_minmax(snd_pcm_t *pcm, snd_pcm_hw_params_t
unsigned int snd_pcm_hw_params_set_period_time_near(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int *dir);
unsigned int snd_pcm_hw_params_set_period_time_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, int *dir);
unsigned int snd_pcm_hw_params_set_period_time_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, int *dir);
-
snd_pcm_sframes_t snd_pcm_hw_params_get_period_size(const snd_pcm_hw_params_t *params, int *dir);
snd_pcm_uframes_t snd_pcm_hw_params_get_period_size_min(const snd_pcm_hw_params_t *params, int *dir);
snd_pcm_uframes_t snd_pcm_hw_params_get_period_size_max(const snd_pcm_hw_params_t *params, int *dir);
@@ -612,7 +607,6 @@ snd_pcm_uframes_t snd_pcm_hw_params_set_period_size_near(snd_pcm_t *pcm, snd_pcm
snd_pcm_uframes_t snd_pcm_hw_params_set_period_size_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, int *dir);
snd_pcm_uframes_t snd_pcm_hw_params_set_period_size_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, int *dir);
int snd_pcm_hw_params_set_period_size_integer(snd_pcm_t *pcm, snd_pcm_hw_params_t *params);
-
int snd_pcm_hw_params_get_periods(const snd_pcm_hw_params_t *params, int *dir);
unsigned int snd_pcm_hw_params_get_periods_min(const snd_pcm_hw_params_t *params, int *dir);
unsigned int snd_pcm_hw_params_get_periods_max(const snd_pcm_hw_params_t *params, int *dir);
@@ -625,7 +619,6 @@ unsigned int snd_pcm_hw_params_set_periods_near(snd_pcm_t *pcm, snd_pcm_hw_param
unsigned int snd_pcm_hw_params_set_periods_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, int *dir);
unsigned int snd_pcm_hw_params_set_periods_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, int *dir);
int snd_pcm_hw_params_set_periods_integer(snd_pcm_t *pcm, snd_pcm_hw_params_t *params);
-
int snd_pcm_hw_params_get_buffer_time(const snd_pcm_hw_params_t *params, int *dir);
unsigned int snd_pcm_hw_params_get_buffer_time_min(const snd_pcm_hw_params_t *params, int *dir);
unsigned int snd_pcm_hw_params_get_buffer_time_max(const snd_pcm_hw_params_t *params, int *dir);
@@ -637,7 +630,6 @@ int snd_pcm_hw_params_set_buffer_time_minmax(snd_pcm_t *pcm, snd_pcm_hw_params_t
unsigned int snd_pcm_hw_params_set_buffer_time_near(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int *dir);
unsigned int snd_pcm_hw_params_set_buffer_time_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, int *dir);
unsigned int snd_pcm_hw_params_set_buffer_time_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, int *dir);
-
snd_pcm_sframes_t snd_pcm_hw_params_get_buffer_size(const snd_pcm_hw_params_t *params);
snd_pcm_uframes_t snd_pcm_hw_params_get_buffer_size_min(const snd_pcm_hw_params_t *params);
snd_pcm_uframes_t snd_pcm_hw_params_get_buffer_size_max(const snd_pcm_hw_params_t *params);
@@ -649,7 +641,6 @@ int snd_pcm_hw_params_set_buffer_size_minmax(snd_pcm_t *pcm, snd_pcm_hw_params_t
snd_pcm_uframes_t snd_pcm_hw_params_set_buffer_size_near(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t val);
snd_pcm_uframes_t snd_pcm_hw_params_set_buffer_size_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params);
snd_pcm_uframes_t snd_pcm_hw_params_set_buffer_size_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params);
-
int snd_pcm_hw_params_get_tick_time(const snd_pcm_hw_params_t *params, int *dir);
unsigned int snd_pcm_hw_params_get_tick_time_min(const snd_pcm_hw_params_t *params, int *dir);
unsigned int snd_pcm_hw_params_get_tick_time_max(const snd_pcm_hw_params_t *params, int *dir);
@@ -671,39 +662,28 @@ size_t snd_pcm_sw_params_sizeof(void);
int snd_pcm_sw_params_malloc(snd_pcm_sw_params_t **ptr);
void snd_pcm_sw_params_free(snd_pcm_sw_params_t *obj);
void snd_pcm_sw_params_copy(snd_pcm_sw_params_t *dst, const snd_pcm_sw_params_t *src);
-
int snd_pcm_sw_params_set_start_mode(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_start_t val);
snd_pcm_start_t snd_pcm_sw_params_get_start_mode(const snd_pcm_sw_params_t *params);
-
int snd_pcm_sw_params_set_xrun_mode(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_xrun_t val);
snd_pcm_xrun_t snd_pcm_sw_params_get_xrun_mode(const snd_pcm_sw_params_t *params);
-
int snd_pcm_sw_params_set_tstamp_mode(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_tstamp_t val);
snd_pcm_tstamp_t snd_pcm_sw_params_get_tstamp_mode(const snd_pcm_sw_params_t *params);
-
#if 0
int snd_pcm_sw_params_set_period_step(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, unsigned int val);
unsigned int snd_pcm_sw_params_get_period_step(const snd_pcm_sw_params_t *params);
#endif
-
int snd_pcm_sw_params_set_sleep_min(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, unsigned int val);
unsigned int snd_pcm_sw_params_get_sleep_min(const snd_pcm_sw_params_t *params);
-
int snd_pcm_sw_params_set_avail_min(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val);
snd_pcm_uframes_t snd_pcm_sw_params_get_avail_min(const snd_pcm_sw_params_t *params);
-
int snd_pcm_sw_params_set_xfer_align(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val);
snd_pcm_uframes_t snd_pcm_sw_params_get_xfer_align(const snd_pcm_sw_params_t *params);
-
int snd_pcm_sw_params_set_start_threshold(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val);
snd_pcm_uframes_t snd_pcm_sw_params_get_start_threshold(const snd_pcm_sw_params_t *params);
-
int snd_pcm_sw_params_set_stop_threshold(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val);
snd_pcm_uframes_t snd_pcm_sw_params_get_stop_threshold(const snd_pcm_sw_params_t *params);
-
int snd_pcm_sw_params_set_silence_threshold(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val);
snd_pcm_uframes_t snd_pcm_sw_params_get_silence_threshold(const snd_pcm_sw_params_t *params);
-
int snd_pcm_sw_params_set_silence_size(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val);
snd_pcm_uframes_t snd_pcm_sw_params_get_silence_size(const snd_pcm_sw_params_t *params);
@@ -716,17 +696,11 @@ size_t snd_pcm_status_sizeof(void);
int snd_pcm_status_malloc(snd_pcm_status_t **ptr);
void snd_pcm_status_free(snd_pcm_status_t *obj);
void snd_pcm_status_copy(snd_pcm_status_t *dst, const snd_pcm_status_t *src);
-
snd_pcm_state_t snd_pcm_status_get_state(const snd_pcm_status_t *obj);
-
void snd_pcm_status_get_trigger_tstamp(const snd_pcm_status_t *obj, snd_timestamp_t *ptr);
-
void snd_pcm_status_get_tstamp(const snd_pcm_status_t *obj, snd_timestamp_t *ptr);
-
snd_pcm_sframes_t snd_pcm_status_get_delay(const snd_pcm_status_t *obj);
-
snd_pcm_uframes_t snd_pcm_status_get_avail(const snd_pcm_status_t *obj);
-
snd_pcm_uframes_t snd_pcm_status_get_avail_max(const snd_pcm_status_t *obj);
size_t snd_pcm_info_sizeof(void);
@@ -738,36 +712,24 @@ size_t snd_pcm_info_sizeof(void);
int snd_pcm_info_malloc(snd_pcm_info_t **ptr);
void snd_pcm_info_free(snd_pcm_info_t *obj);
void snd_pcm_info_copy(snd_pcm_info_t *dst, const snd_pcm_info_t *src);
-
unsigned int snd_pcm_info_get_device(const snd_pcm_info_t *obj);
-
unsigned int snd_pcm_info_get_subdevice(const snd_pcm_info_t *obj);
-
snd_pcm_stream_t snd_pcm_info_get_stream(const snd_pcm_info_t *obj);
-
int snd_pcm_info_get_card(const snd_pcm_info_t *obj);
-
const char *snd_pcm_info_get_id(const snd_pcm_info_t *obj);
-
const char *snd_pcm_info_get_name(const snd_pcm_info_t *obj);
-
const char *snd_pcm_info_get_subdevice_name(const snd_pcm_info_t *obj);
-
snd_pcm_class_t snd_pcm_info_get_class(const snd_pcm_info_t *obj);
-
snd_pcm_subclass_t snd_pcm_info_get_subclass(const snd_pcm_info_t *obj);
-
unsigned int snd_pcm_info_get_subdevices_count(const snd_pcm_info_t *obj);
-
unsigned int snd_pcm_info_get_subdevices_avail(const snd_pcm_info_t *obj);
-
void snd_pcm_info_set_device(snd_pcm_info_t *obj, unsigned int val);
-
void snd_pcm_info_set_subdevice(snd_pcm_info_t *obj, unsigned int val);
-
void snd_pcm_info_set_stream(snd_pcm_info_t *obj, snd_pcm_stream_t val);
#ifdef __cplusplus
}
#endif
+/** \} */
+
diff --git a/include/rawmidi.h b/include/rawmidi.h
index 2a8e353e..32bbdace 100644
--- a/include/rawmidi.h
+++ b/include/rawmidi.h
@@ -5,6 +5,12 @@
* *
****************************************************************************/
+/**
+ * \defgroup RawMidi RawMidi Interface
+ * The RawMidi Interface.
+ * \{
+ */
+
/** RawMidi information container */
typedef struct _snd_rawmidi_info snd_rawmidi_info_t;
/** RawMidi settings container */
@@ -115,3 +121,5 @@ snd_rawmidi_stream_t snd_rawmidi_stream(snd_rawmidi_t *rawmidi);
}
#endif
+/** \} */
+
diff --git a/include/seq.h b/include/seq.h
index 1cdeff8a..7fcb940b 100644
--- a/include/seq.h
+++ b/include/seq.h
@@ -5,6 +5,12 @@
* *
****************************************************************************/
+/**
+ * \defgroup Sequencer Sequencer Interface
+ * Sequencer Interface
+ * \{
+ */
+
typedef sndrv_seq_tick_time_t snd_seq_tick_time_t;
typedef sndrv_seq_position_t snd_seq_position_t;
typedef sndrv_seq_frequency_t snd_seq_frequency_t;
@@ -399,3 +405,5 @@ int snd_seq_get_bit(int nr, void *array);
}
#endif
+/** \} */
+
diff --git a/include/seq_midi_event.h b/include/seq_midi_event.h
index 8d1e1f08..5546490a 100644
--- a/include/seq_midi_event.h
+++ b/include/seq_midi_event.h
@@ -4,6 +4,13 @@
* *
****************************************************************************/
+/**
+ * \defgroup MIDI_Event Sequencer event <-> MIDI byte stream coder
+ * \ingroup Sequencer
+ * Sequencer event <-> MIDI byte stream coder
+ * \{
+ */
+
typedef struct snd_midi_event snd_midi_event_t;
#ifdef __cplusplus
@@ -26,3 +33,5 @@ long snd_midi_event_decode(snd_midi_event_t *dev, unsigned char *buf, long count
}
#endif
+/** \} */
+
diff --git a/include/seqmid.h b/include/seqmid.h
index a9cd6335..63dc11c5 100644
--- a/include/seqmid.h
+++ b/include/seqmid.h
@@ -4,6 +4,13 @@
* *
****************************************************************************/
+/**
+ * \defgroup SeqMiddle Sequencer Middle Level Interface
+ * Sequencer Middle Level Interface
+ * \ingroup Sequencer
+ * \{
+ */
+
#ifdef __cplusplus
extern "C" {
#endif
@@ -212,3 +219,5 @@ int snd_seq_reset_pool_input(snd_seq_t *seq);
}
#endif
+/** \} */
+
diff --git a/include/timer.h b/include/timer.h
index c9b64958..2e830b7f 100644
--- a/include/timer.h
+++ b/include/timer.h
@@ -5,6 +5,12 @@
* *
****************************************************************************/
+/**
+ * \defgroup Timer Timer Interface
+ * Timer Interface
+ * \{
+ */
+
typedef struct sndrv_timer_id snd_timer_id_t;
typedef struct sndrv_timer_select snd_timer_select_t;
typedef struct sndrv_timer_info snd_timer_info_t;
@@ -62,3 +68,5 @@ ssize_t snd_timer_read(snd_timer_t *handle, void *buffer, size_t size);
}
#endif
+/** \} */
+
diff --git a/src/conf.c b/src/conf.c
index af20fc7e..f6208234 100644
--- a/src/conf.c
+++ b/src/conf.c
@@ -1164,7 +1164,8 @@ int snd_config_search_alias(snd_config_t *config,
/** File resident in home directory used for user specific ALSA configuration */
#define USR_ASOUNDRC ".asoundrc"
-/** Config top node */
+/** \ingroup Config
+ * Config top node */
snd_config_t *snd_config = NULL;
/**
diff --git a/src/error.c b/src/error.c
index 80416d48..160c970c 100644
--- a/src/error.c
+++ b/src/error.c
@@ -80,6 +80,7 @@ static void snd_lib_error_default(const char *file, int line, const char *functi
}
/**
+ * \ingroup Error
* Pointer to the error handler function.
*/
snd_lib_error_handler_t *snd_lib_error = snd_lib_error_default;