Fix doxygen documents

Fix the warnings of doxygen parsing.
Add some missing documentation.
This commit is contained in:
Takashi Iwai 2005-05-24 14:14:28 +00:00
parent 7651690858
commit 087184b0f9
49 changed files with 300 additions and 167 deletions

View file

@ -172,12 +172,18 @@ int snd_config_get_ctl_iface(const snd_config_t *conf);
/* Names functions */
/**
* Device-name list element
*/
typedef struct snd_devname snd_devname_t;
/**
* Device-name list element (definition)
*/
struct snd_devname {
char *name;
char *comment;
snd_devname_t *next;
char *name; /**< Device name string */
char *comment; /**< Comments */
snd_devname_t *next; /**< Next pointer */
};
int snd_names_list(const char *interface, snd_devname_t **list);

View file

@ -368,8 +368,8 @@ 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);
int snd_ctl_elem_add_integer(snd_ctl_t *ctl, const snd_ctl_elem_id_t *id, unsigned int count, long imin, long imax, long istep);;
int snd_ctl_elem_add_integer64(snd_ctl_t *ctl, const snd_ctl_elem_id_t *id, unsigned int count, long long imin, long long imax, long long istep);;
int snd_ctl_elem_add_integer(snd_ctl_t *ctl, const snd_ctl_elem_id_t *id, unsigned int count, long imin, long imax, long istep);
int snd_ctl_elem_add_integer64(snd_ctl_t *ctl, const snd_ctl_elem_id_t *id, unsigned int count, long long imin, long long imax, long long istep);
int snd_ctl_elem_add_boolean(snd_ctl_t *ctl, const snd_ctl_elem_id_t *id, unsigned int count);
int snd_ctl_elem_add_iec958(snd_ctl_t *ctl, const snd_ctl_elem_id_t *id);
int snd_ctl_elem_remove(snd_ctl_t *ctl, snd_ctl_elem_id_t *id);

View file

@ -51,7 +51,7 @@ extern "C" {
/**
* \brief set the tag for given event
* \param ev event record
* \param tag event tag
* \param t event tag
*
* This macro sets the tag to the given event record.
*/
@ -195,8 +195,8 @@ extern "C" {
/**
* \brief set varusr data
* \param ev event instance
* \param len length of the external data
* \param ptr pointer of the external data
* \param datalen length of the external data
* \param dataptr pointer of the external data
*
* Sets the event length mode as variable user-space data and stores the data.
*

View file

@ -100,9 +100,9 @@ typedef struct _snd_timer_read {
/** timer tstamp + event read structure */
typedef struct _snd_timer_tread {
snd_timer_event_t event;
snd_htimestamp_t tstamp;
unsigned int val;
snd_timer_event_t event; /**< Timer event */
snd_htimestamp_t tstamp; /**< Time stamp of each event */
unsigned int val; /**< Event value */
} snd_timer_tread_t;
/** global timer - system */