summaryrefslogtreecommitdiff
path: root/src/seq
diff options
context:
space:
mode:
authorTakashi Iwai <tiwai@suse.de>2005-05-24 14:14:28 +0000
committerTakashi Iwai <tiwai@suse.de>2005-05-24 14:14:28 +0000
commit087184b0f9607fbdb84e4a7e4a0d67ad875c2f44 (patch)
tree6d1a1d7b25ef9fafe99f9c615482105073a4b5a0 /src/seq
parent7651690858a8b026f2a4447e804ee8bf1a155ebb (diff)
Fix doxygen documents
Fix the warnings of doxygen parsing. Add some missing documentation.
Diffstat (limited to 'src/seq')
-rw-r--r--src/seq/seq.c36
-rw-r--r--src/seq/seq_hw.c2
-rw-r--r--src/seq/seq_midi_event.c6
-rw-r--r--src/seq/seqmid.c4
4 files changed, 25 insertions, 23 deletions
diff --git a/src/seq/seq.c b/src/seq/seq.c
index 0b56a702..49898ef3 100644
--- a/src/seq/seq.c
+++ b/src/seq/seq.c
@@ -235,7 +235,7 @@ The queue field is the queue id for scheduling.
The source and dest fields are source and destination addresses.
The data field is a union of event data.
-\subsction seq_ev_queue Scheduling queue
+\subsection seq_ev_queue Scheduling queue
An event can be delivered either on scheduled or direct dispatch mode.
On the scheduling mode, an event is once stored on the priority queue
@@ -978,6 +978,7 @@ int snd_seq_open(snd_seq_t **seqp, const char *name,
* \brief Open the ALSA sequencer using local configuration
*
* \param seqp Pointer to a snd_seq_t pointer.
+ * \param name The name to open
* \param streams The read/write mode of the sequencer.
* \param mode Optional modifier
* \param lconf Local configuration
@@ -997,7 +998,7 @@ int snd_seq_open_lconf(snd_seq_t **seqp, const char *name,
/**
* \brief Close the sequencer
- * \param handle Handle returned from #snd_seq_open()
+ * \param seq Handle returned from #snd_seq_open()
* \return 0 on success otherwise a negative error code
*
* Closes the sequencer client and releases its resources.
@@ -1275,7 +1276,7 @@ int snd_seq_system_info_malloc(snd_seq_system_info_t **ptr)
/**
* \brief Frees a previously allocated #snd_seq_system_info_t
- * \param pointer to object to free
+ * \param obj pointer to object to free
*/
void snd_seq_system_info_free(snd_seq_system_info_t *obj)
{
@@ -1416,7 +1417,7 @@ int snd_seq_client_info_malloc(snd_seq_client_info_t **ptr)
/**
* \brief frees a previously allocated #snd_seq_client_info_t
- * \param pointer to object to free
+ * \param obj pointer to object to free
*/
void snd_seq_client_info_free(snd_seq_client_info_t *obj)
{
@@ -1734,7 +1735,7 @@ int snd_seq_port_info_malloc(snd_seq_port_info_t **ptr)
/**
* \brief frees a previously allocated #snd_seq_port_info_t
- * \param pointer to object to free
+ * \param obj pointer to object to free
*/
void snd_seq_port_info_free(snd_seq_port_info_t *obj)
{
@@ -2016,7 +2017,7 @@ void snd_seq_port_info_set_capability(snd_seq_port_info_t *info, unsigned int ca
/**
* \brief Get the type bits of a port_info container
* \param info port_info container
- * \return port type bits
+ * \param type port type bits
*
* \sa snd_seq_get_port_info(), snd_seq_port_info_get_type()
*/
@@ -2304,7 +2305,7 @@ int snd_seq_port_subscribe_malloc(snd_seq_port_subscribe_t **ptr)
/**
* \brief frees a previously allocated #snd_seq_port_subscribe_t
- * \param pointer to object to free
+ * \param obj pointer to object to free
*/
void snd_seq_port_subscribe_free(snd_seq_port_subscribe_t *obj)
{
@@ -2326,7 +2327,6 @@ void snd_seq_port_subscribe_copy(snd_seq_port_subscribe_t *dst, const snd_seq_po
/**
* \brief Get sender address of a port_subscribe container
* \param info port_subscribe container
- * \param addr sender address
*
* \sa snd_seq_subscribe_port(), snd_seq_port_subscribe_set_sender()
*/
@@ -2339,7 +2339,6 @@ const snd_seq_addr_t *snd_seq_port_subscribe_get_sender(const snd_seq_port_subsc
/**
* \brief Get destination address of a port_subscribe container
* \param info port_subscribe container
- * \param addr destination address
*
* \sa snd_seq_subscribe_port(), snd_seq_port_subscribe_set_dest()
*/
@@ -2564,7 +2563,7 @@ int snd_seq_query_subscribe_malloc(snd_seq_query_subscribe_t **ptr)
/**
* \brief frees a previously allocated #snd_seq_query_subscribe_t
- * \param pointer to object to free
+ * \param obj pointer to object to free
*/
void snd_seq_query_subscribe_free(snd_seq_query_subscribe_t *obj)
{
@@ -2848,7 +2847,7 @@ int snd_seq_queue_info_malloc(snd_seq_queue_info_t **ptr)
/**
* \brief frees a previously allocated #snd_seq_queue_info_t
- * \param pointer to object to free
+ * \param obj pointer to object to free
*/
void snd_seq_queue_info_free(snd_seq_queue_info_t *obj)
{
@@ -3110,7 +3109,6 @@ int snd_seq_query_named_queue(snd_seq_t *seq, const char *name)
* \brief Get the queue usage flag to the client
* \param seq sequencer handle
* \param q queue id
- * \param client client id
* \return 1 = client is allowed to access the queue, 0 = not allowed,
* otherwise a negative error code
*
@@ -3133,7 +3131,6 @@ int snd_seq_get_queue_usage(snd_seq_t *seq, int q)
* \brief Set the queue usage flag to the client
* \param seq sequencer handle
* \param q queue id
- * \param client client id
* \param used non-zero if the client is allowed
* \return 0 on success otherwise a negative error code
*
@@ -3176,7 +3173,7 @@ int snd_seq_queue_status_malloc(snd_seq_queue_status_t **ptr)
/**
* \brief frees a previously allocated #snd_seq_queue_status_t
- * \param pointer to object to free
+ * \param obj pointer to object to free
*/
void snd_seq_queue_status_free(snd_seq_queue_status_t *obj)
{
@@ -3237,7 +3234,6 @@ snd_seq_tick_time_t snd_seq_queue_status_get_tick_time(const snd_seq_queue_statu
/**
* \brief Get the real time of a queue_status container
* \param info queue_status container
- * \param time real time
*
* \sa snd_seq_get_queue_status()
*/
@@ -3304,7 +3300,7 @@ int snd_seq_queue_tempo_malloc(snd_seq_queue_tempo_t **ptr)
/**
* \brief frees a previously allocated #snd_seq_queue_tempo_t
- * \param pointer to object to free
+ * \param obj pointer to object to free
*/
void snd_seq_queue_tempo_free(snd_seq_queue_tempo_t *obj)
{
@@ -3504,7 +3500,7 @@ int snd_seq_queue_timer_malloc(snd_seq_queue_timer_t **ptr)
/**
* \brief frees a previously allocated #snd_seq_queue_timer_t
- * \param pointer to object to free
+ * \param obj pointer to object to free
*/
void snd_seq_queue_timer_free(snd_seq_queue_timer_t *obj)
{
@@ -4127,7 +4123,7 @@ int snd_seq_remove_events_malloc(snd_seq_remove_events_t **ptr)
/**
* \brief frees a previously allocated #snd_seq_remove_events_t
- * \param pointer to object to free
+ * \param obj pointer to object to free
*/
void snd_seq_remove_events_free(snd_seq_remove_events_t *obj)
{
@@ -4487,7 +4483,7 @@ int snd_seq_client_pool_malloc(snd_seq_client_pool_t **ptr)
/**
* \brief frees a previously allocated #snd_seq_client_pool_t
- * \param pointer to object to free
+ * \param obj pointer to object to free
*/
void snd_seq_client_pool_free(snd_seq_client_pool_t *obj)
{
@@ -4699,7 +4695,7 @@ int snd_instr_header_malloc(snd_instr_header_t **ptr, size_t len)
/**
* \brief frees a previously allocated #snd_instr_header_t
- * \param pointer to object to free
+ * \param obj poitner to object to free
*/
void snd_instr_header_free(snd_instr_header_t *obj)
{
diff --git a/src/seq/seq_hw.c b/src/seq/seq_hw.c
index c58a46ae..a2a01455 100644
--- a/src/seq/seq_hw.c
+++ b/src/seq/seq_hw.c
@@ -29,6 +29,7 @@
const char *_snd_module_seq_hw = "";
#endif
+#ifndef DOC_HIDDEN
#define SNDRV_FILE_SEQ "/dev/snd/seq"
#define SNDRV_FILE_ALOADSEQ "/dev/aloadSEQ"
#define SNDRV_SEQ_VERSION_MAX SNDRV_PROTOCOL_VERSION(1, 0, 1)
@@ -36,6 +37,7 @@ const char *_snd_module_seq_hw = "";
typedef struct {
int fd;
} snd_seq_hw_t;
+#endif /* DOC_HIDDEN */
static int snd_seq_hw_close(snd_seq_t *seq)
{
diff --git a/src/seq/seq_midi_event.c b/src/seq/seq_midi_event.c
index 3467a0c1..0c101619 100644
--- a/src/seq/seq_midi_event.c
+++ b/src/seq/seq_midi_event.c
@@ -78,6 +78,7 @@ static void songpos_decode(const snd_seq_event_t *ev, unsigned char *buf);
/*
* event list
*/
+#ifndef DOC_HIDDEN
static struct status_event_list_t {
int event;
int qlen;
@@ -124,9 +125,8 @@ static struct extra_event_list_t {
{SND_SEQ_EVENT_REGPARAM, extra_decode_xrpn},
};
-#ifndef DOC_HIDDEN
#define numberof(ary) (sizeof(ary)/sizeof(ary[0]))
-#endif
+#endif /* DOC_HIDDEN */
/**
* \brief Initialize MIDI event parser
@@ -159,7 +159,7 @@ int snd_midi_event_new(size_t bufsize, snd_midi_event_t **rdev)
/**
* \brief Free MIDI event parser
- * \param rdev MIDI event parser
+ * \param dev MIDI event parser
* \return 0 on success otherwise a negative error code
*
* Frees MIDI event parser.
diff --git a/src/seq/seqmid.c b/src/seq/seqmid.c
index 779e3e74..b4160827 100644
--- a/src/seq/seqmid.c
+++ b/src/seq/seqmid.c
@@ -107,6 +107,7 @@ int snd_seq_delete_simple_port(snd_seq_t *seq, int port)
/**
* \brief simple subscription (w/o exclusive & time conversion)
+ * \param seq sequencer handle
* \param myport the port id as receiver
* \param src_client sender client id
* \param src_port sender port id
@@ -133,6 +134,7 @@ int snd_seq_connect_from(snd_seq_t *seq, int myport, int src_client, int src_por
/**
* \brief simple subscription (w/o exclusive & time conversion)
+ * \param seq sequencer handle
* \param myport the port id as sender
* \param dest_client destination client id
* \param dest_port destination port id
@@ -159,6 +161,7 @@ int snd_seq_connect_to(snd_seq_t *seq, int myport, int dest_client, int dest_por
/**
* \brief simple disconnection
+ * \param seq sequencer handle
* \param myport the port id as receiver
* \param src_client sender client id
* \param src_port sender port id
@@ -185,6 +188,7 @@ int snd_seq_disconnect_from(snd_seq_t *seq, int myport, int src_client, int src_
/**
* \brief simple disconnection
+ * \param seq sequencer handle
* \param myport the port id as sender
* \param dest_client destination client id
* \param dest_port destination port id