mirrors/alsa-lib
1
0
Fork 0
mirror of https://github.com/alsa-project/alsa-lib.git synced 2025-11-03 09:01:52 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Fix doxygen documents

Browse source 
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
Download patch file Download diff file Expand all files Collapse all files

23
src/control/control.c
View file

@ -406,7 +406,7 @@ int snd_ctl_elem_write(snd_ctl_t *ctl, snd_ctl_elem_value_t *control)
/**
* \brief Lock CTL element
* \param ctl CTL handle
* \param control CTL element id pointer
* \param id CTL element id pointer
* \return 0 on success otherwise a negative error code
*/
int snd_ctl_elem_lock(snd_ctl_t *ctl, snd_ctl_elem_id_t *id)
@ -418,7 +418,7 @@ int snd_ctl_elem_lock(snd_ctl_t *ctl, snd_ctl_elem_id_t *id)
/**
* \brief Unlock CTL element
* \param ctl CTL handle
* \param control CTL element id pointer
* \param id CTL element id pointer
* \return 0 on success otherwise a negative error code
*/
int snd_ctl_elem_unlock(snd_ctl_t *ctl, snd_ctl_elem_id_t *id)
@ -998,7 +998,7 @@ int snd_ctl_elem_id_malloc(snd_ctl_elem_id_t **ptr)
/**
* \brief frees a previously allocated #snd_ctl_elem_id_t
* \param pointer to object to free
* \param obj pointer to object to free
*/
void snd_ctl_elem_id_free(snd_ctl_elem_id_t *obj)
{
@ -1182,7 +1182,7 @@ int snd_ctl_card_info_malloc(snd_ctl_card_info_t **ptr)
/**
* \brief frees a previously allocated #snd_ctl_card_info_t
* \param pointer to object to free
* \param obj pointer to object to free
*/
void snd_ctl_card_info_free(snd_ctl_card_info_t *obj)
{
@ -1311,7 +1311,7 @@ int snd_ctl_event_malloc(snd_ctl_event_t **ptr)
/**
* \brief frees a previously allocated #snd_ctl_event_t
* \param pointer to object to free
* \param obj pointer to object to free
*/
void snd_ctl_event_free(snd_ctl_event_t *obj)
{
@ -1374,7 +1374,7 @@ int snd_ctl_elem_list_malloc(snd_ctl_elem_list_t **ptr)
/**
* \brief frees a previously allocated #snd_ctl_elem_list_t
* \param pointer to object to free
* \param obj pointer to object to free
*/
void snd_ctl_elem_list_free(snd_ctl_elem_list_t *obj)
{
@ -1550,7 +1550,7 @@ int snd_ctl_elem_info_malloc(snd_ctl_elem_info_t **ptr)
/**
* \brief frees a previously allocated #snd_ctl_elem_info_t
* \param pointer to object to free
* \param obj pointer to object to free
*/
void snd_ctl_elem_info_free(snd_ctl_elem_info_t *obj)
{
@ -1832,6 +1832,7 @@ use_default_symbol_version(__snd_ctl_elem_info_get_dimensions, snd_ctl_elem_info
/**
* \brief Get specified of dimension width for given element
* \param obj CTL element id/info
* \param idx The dimension index
* \return zero value if no dimension width is defined, otherwise positive value with with of specified dimension
*/
#ifndef DOXYGEN
@ -2028,7 +2029,7 @@ int snd_ctl_elem_value_malloc(snd_ctl_elem_value_t **ptr)
/**
* \brief frees a previously allocated #snd_ctl_elem_value_t
* \param pointer to object to free
* \param obj pointer to object to free
*/
void snd_ctl_elem_value_free(snd_ctl_elem_value_t *obj)
{
@ -2336,7 +2337,7 @@ void snd_ctl_elem_value_set_byte(snd_ctl_elem_value_t *obj, unsigned int idx, un
/**
* \brief Set CTL element #SND_CTL_ELEM_TYPE_BYTES value
* \param ctl CTL handle
* \param obj CTL handle
* \param data Bytes value
* \param size Size in bytes
*/
@ -2364,7 +2365,7 @@ const void * snd_ctl_elem_value_get_bytes(const snd_ctl_elem_value_t *obj)
/**
* \brief Get value for a #SND_CTL_ELEM_TYPE_IEC958 CTL element id/value
* \param obj CTL element id/value
* \param Pointer to returned CTL element value
* \param ptr Pointer to returned CTL element value
*/
void snd_ctl_elem_value_get_iec958(const snd_ctl_elem_value_t *obj, snd_aes_iec958_t *ptr)
{
@ -2375,7 +2376,7 @@ void snd_ctl_elem_value_get_iec958(const snd_ctl_elem_value_t *obj, snd_aes_iec9
/**
* \brief Set value for a #SND_CTL_ELEM_TYPE_IEC958 CTL element id/value
* \param obj CTL element id/value
* \param Pointer to CTL element value
* \param ptr Pointer to CTL element value
*/
void snd_ctl_elem_value_set_iec958(snd_ctl_elem_value_t *obj, const snd_aes_iec958_t *ptr)
{

2
src/control/control_hw.c
View file

@ -38,6 +38,7 @@ const char *_snd_module_control_hw = "";
#define F_SETSIG 10
#endif
#ifndef DOC_HIDDEN
#define SNDRV_FILE_CONTROL "/dev/snd/controlC%i"
#define SNDRV_CTL_VERSION_MAX SNDRV_PROTOCOL_VERSION(2, 0, 3)
@ -45,6 +46,7 @@ typedef struct {
int card;
int fd;
} snd_ctl_hw_t;
#endif /* DOC_HIDDEN */
static int snd_ctl_hw_close(snd_ctl_t *handle)
{

2
src/control/control_shm.c
View file

@ -40,10 +40,12 @@
const char *_snd_module_control_shm = "";
#endif
#ifndef DOC_HIDDEN
typedef struct {
int socket;
volatile snd_ctl_shm_ctrl_t *ctrl;
} snd_ctl_shm_t;
#endif
static int snd_ctl_shm_action(snd_ctl_t *ctl)
{

2
src/control/hcontrol.c
View file

@ -187,7 +187,7 @@ int snd_hctl_poll_descriptors(snd_hctl_t *hctl, struct pollfd *pfds, unsigned in
/**
* \brief get returned events from poll descriptors
* \param ctl HCTL handle
* \param hctl HCTL handle
* \param pfds array of poll descriptors
* \param nfds count of poll descriptors
* \param revents returned events

2
src/control/setup.c
View file

@ -37,6 +37,7 @@
#include <ctype.h>
#include "local.h"
#ifndef DOC_HIDDEN
typedef struct {
unsigned int lock: 1;
unsigned int preserve: 1;
@ -53,6 +54,7 @@ struct _snd_sctl {
snd_ctl_t *ctl;
struct list_head elems;
};
#endif /* DOC_HIDDEN */
static int free_elems(snd_sctl_t *h)
{