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

@ -422,7 +422,7 @@ int snd_rawmidi_poll_descriptors(snd_rawmidi_t *rawmidi, struct pollfd *pfds, un
/**
* \brief get returned events from poll descriptors
* \param pcm rawmidi RawMidi handle
* \param rawmidi rawmidi RawMidi handle
* \param pfds array of poll descriptors
* \param nfds count of poll descriptors
* \param revents returned events
@ -472,7 +472,7 @@ size_t snd_rawmidi_info_sizeof()
/**
* \brief allocate a new snd_rawmidi_info_t structure
* \param ptr returned pointer
* \param info returned pointer
* \return 0 on success otherwise a negative error code if fails
*
* Allocates a new snd_rawmidi_params_t structure using the standard
@ -678,7 +678,7 @@ size_t snd_rawmidi_params_sizeof()
/**
* \brief allocate the snd_rawmidi_params_t structure
* \param ptr returned pointer
* \param params returned pointer
* \return 0 on success otherwise a negative error code if fails
*
* Allocates a new snd_rawmidi_params_t structure using the standard

View file

@ -37,11 +37,13 @@ const char *_snd_module_rawmidi_hw = "";
#define SNDRV_FILE_RAWMIDI "/dev/snd/midiC%iD%i"
#define SNDRV_RAWMIDI_VERSION_MAX SNDRV_PROTOCOL_VERSION(2, 0, 0)
#ifndef DOC_HIDDEN
typedef struct {
int open;
int fd;
int card, device, subdevice;
} snd_rawmidi_hw_t;
#endif
static int snd_rawmidi_hw_close(snd_rawmidi_t *rmidi)
{

View file

@ -35,6 +35,7 @@ const char *_snd_module_rawmidi_virt = "";
#endif
#ifndef DOC_HIDDEN
typedef struct {
int open;
@ -52,6 +53,7 @@ typedef struct {
snd_seq_event_t out_event;
int pending;
} snd_rawmidi_virtual_t;
#endif
static int snd_rawmidi_virtual_close(snd_rawmidi_t *rmidi)
{