More documentation enhancements / removal of non-existent functions.

include/conf.h

@@ -93,8 +93,6 @@ int snd_config_get_bool(snd_config_t *conf);
 int snd_config_get_ctl_iface_ascii(const char *ascii);
 int snd_config_get_ctl_iface(snd_config_t *conf);
 
-typedef int (snd_config_string_replace_callback_t)(const char *what, char **dst, void *private_data);
-
 int snd_config_refer_load(snd_config_t **dst, char **name,
 			  snd_config_t *root, snd_config_t *config);
 

include/control.h

@@ -11,6 +11,7 @@
  *  \{
  */
 
+/** IEC958 structure */
 typedef struct sndrv_aes_iec958 snd_aes_iec958_t;
 
 /** CTL card info container */
@@ -393,7 +394,6 @@ 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);

include/hwdep.h

@@ -5,6 +5,12 @@
  *                                                                          *
  ****************************************************************************/
 
+/**
+ *  \defgroup HwDep Hardware Dependant Interface
+ *  The Hardware Dependant Interface.
+ *  \{
+ */
+
 /** HwDep information container */
 typedef struct _snd_hwdep_info snd_hwdep_info_t;
 
@@ -40,7 +46,22 @@ int snd_hwdep_ioctl(snd_hwdep_t *hwdep, unsigned int request, void * arg);
 ssize_t snd_hwdep_write(snd_hwdep_t *hwdep, const void *buffer, size_t size);
 ssize_t snd_hwdep_read(snd_hwdep_t *hwdep, void *buffer, size_t size);
 
+size_t snd_hwdep_info_sizeof(void);
+#define snd_hwdep_info_alloca(ptr) do { assert(ptr); *ptr = (snd_hwdep_info_t *) alloca(snd_hwdep_info_sizeof()); memset(*ptr, 0, snd_hwdep_info_sizeof()); } while (0)
+int snd_hwdep_info_malloc(snd_hwdep_info_t **ptr);
+void snd_hwdep_info_free(snd_hwdep_info_t *obj);
+void snd_hwdep_info_copy(snd_hwdep_info_t *dst, const snd_hwdep_info_t *src);
+
+unsigned int snd_hwdep_info_get_device(const snd_hwdep_info_t *obj);
+int snd_hwdep_info_get_card(const snd_hwdep_info_t *obj);
+const char *snd_hwdep_info_get_id(const snd_hwdep_info_t *obj);
+const char *snd_hwdep_info_get_name(const snd_hwdep_info_t *obj);
+snd_hwdep_iface_t snd_hwdep_info_get_iface(const snd_hwdep_info_t *obj);
+void snd_hwdep_info_set_device(snd_hwdep_info_t *obj, unsigned int val);
+
 #ifdef __cplusplus
 }
 #endif
 
+/** \} */
+

include/instr.h

@@ -17,6 +17,7 @@
 extern "C" {
 #endif
 
+/** container for sequencer instrument header */
 typedef struct _snd_instr_header snd_instr_header_t;
 
 size_t snd_instr_header_sizeof(void);

include/pcm.h

@@ -738,6 +738,7 @@ 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);
 
+/** type of pcm hook */
 typedef enum _snd_pcm_hook_type {
 	SND_PCM_HOOK_TYPE_HW_PARAMS,
 	SND_PCM_HOOK_TYPE_HW_FREE,
@@ -745,7 +746,9 @@ typedef enum _snd_pcm_hook_type {
 	SND_PCM_HOOK_TYPE_LAST = SND_PCM_HOOK_TYPE_CLOSE,
 } snd_pcm_hook_type_t;
 
+/** PCM hook container */
 typedef struct _snd_pcm_hook snd_pcm_hook_t;
+/** PCM hook callback function */
 typedef int (*snd_pcm_hook_func_t)(snd_pcm_hook_t *hook);
 snd_pcm_t *snd_pcm_hook_get_pcm(snd_pcm_hook_t *hook);
 void *snd_pcm_hook_get_private(snd_pcm_hook_t *hook);

include/rawmidi.h

@@ -108,7 +108,6 @@ void snd_rawmidi_status_free(snd_rawmidi_status_t *obj);
 void snd_rawmidi_status_copy(snd_rawmidi_status_t *dst, const snd_rawmidi_status_t *src);
 void snd_rawmidi_status_get_tstamp(const snd_rawmidi_status_t *obj, snd_timestamp_t *ptr);
 size_t snd_rawmidi_status_get_avail(const snd_rawmidi_status_t *obj);
-size_t snd_rawmidi_status_get_avail_max(const snd_rawmidi_status_t *obj);
 size_t snd_rawmidi_status_get_xruns(const snd_rawmidi_status_t *obj);
 int snd_rawmidi_status(snd_rawmidi_t *rmidi, snd_rawmidi_status_t * status);
 int snd_rawmidi_drain(snd_rawmidi_t *rmidi);

include/seq.h

@@ -32,6 +32,7 @@ do {\
  */
 #define SND_SEQ_NONBLOCK	1	/**< non-blocking mode */
 
+/** sequencer handle type */
 typedef enum _snd_seq_type {
 	SND_SEQ_TYPE_HW,		/**< hardware */
 	SND_SEQ_TYPE_SHM,		/**< shared memory (NYI) */
@@ -543,6 +544,7 @@ enum {
 	SND_SEQ_EVFLG_NOTE_ONEARG,
 	SND_SEQ_EVFLG_NOTE_TWOARG
 };
+
 enum {
 	SND_SEQ_EVFLG_QUEUE_NOARG,
 	SND_SEQ_EVFLG_QUEUE_TICK,
@@ -557,10 +559,11 @@ enum {
  */
 extern const unsigned int snd_seq_event_types[];
 
-#define _SND_SEQ_TYPE(x)	(1<<(x))	/* 24bit */
-#define _SND_SEQ_TYPE_OPT(x)	((x)<<24)	/* 8bit */
+#define _SND_SEQ_TYPE(x)	(1<<(x))	/**< master type - 24bit */
+#define _SND_SEQ_TYPE_OPT(x)	((x)<<24)	/**< optional type - 8bit */
 
-#define snd_seq_type_check(ev,x)	(snd_seq_event_types[(ev)->type] & _SND_SEQ_TYPE(x))
+/** check the event type */
+#define snd_seq_type_check(ev,x) (snd_seq_event_types[(ev)->type] & _SND_SEQ_TYPE(x))
 
 /** event type check: result events */
 #define snd_seq_ev_is_result_type(ev) \

include/seq_event.h

@@ -18,6 +18,7 @@
  */
 typedef unsigned char snd_seq_event_type_t;
 
+/** Sequencer event type */
 enum snd_seq_event_type {
 	/** system status; event data type = #snd_seq_result_t */
 	SND_SEQ_EVENT_SYSTEM = 0,

include/seq_midi_event.h

@@ -11,6 +11,7 @@
  *  \{
  */
 
+/** container for sequencer midi event parsers */
 typedef struct snd_midi_event snd_midi_event_t;
 
 #ifdef __cplusplus