mirrors/alsa-lib
1
0
Fork 0
mirror of https://github.com/alsa-project/alsa-lib.git synced 2025-11-04 13:30:08 -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

12
src/timer/timer.c
View file

@ -436,7 +436,7 @@ size_t snd_timer_info_sizeof()
/**
* \brief allocate a new snd_timer_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_timer_info_t structure using the standard
@ -555,7 +555,7 @@ size_t snd_timer_params_sizeof()
/**
* \brief allocate a new snd_timer_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_timer_params_t structure using the standard
@ -597,6 +597,7 @@ void snd_timer_params_copy(snd_timer_params_t *dst, const snd_timer_params_t *sr
/**
* \brief set timer auto start
* \param params pointer to #snd_timer_params_t structure
* \param auto_start The boolean value to set
*/
int snd_timer_params_set_auto_start(snd_timer_params_t * params, int auto_start)
{
@ -622,6 +623,7 @@ int snd_timer_params_get_auto_start(snd_timer_params_t * params)
/**
* \brief set timer exclusive use
* \param params pointer to #snd_timer_params_t structure
* \param exclusive The boolean value to set
*/
#ifndef DOXYGEN
int INTERNAL(snd_timer_params_set_exclusive)(snd_timer_params_t * params, int exclusive)
@ -657,6 +659,7 @@ use_default_symbol_version(__snd_timer_params_get_exclusive, snd_timer_params_ge
/**
* \brief set timer early event
* \param params pointer to #snd_timer_params_t structure
* \param early_event The boolean value to set
*/
int snd_timer_params_set_early_event(snd_timer_params_t * params, int early_event)
{
@ -682,6 +685,7 @@ int snd_timer_params_get_early_event(snd_timer_params_t * params)
/**
* \brief set timer ticks
* \param params pointer to #snd_timer_params_t structure
* \param ticks Ticks to set
*/
void snd_timer_params_set_ticks(snd_timer_params_t * params, long ticks)
{
@ -703,6 +707,7 @@ long snd_timer_params_get_ticks(snd_timer_params_t * params)
/**
* \brief set timer queue size (32-1024)
* \param params pointer to #snd_timer_params_t structure
* \param queue_size The queue size to set
*/
void snd_timer_params_set_queue_size(snd_timer_params_t * params, long queue_size)
{
@ -724,6 +729,7 @@ long snd_timer_params_get_queue_size(snd_timer_params_t * params)
/**
* \brief set timer event filter
* \param params pointer to #snd_timer_params_t structure
* \param filter The event filter bits to set
*/
#ifndef DOXYGEN
void INTERNAL(snd_timer_params_set_filter)(snd_timer_params_t * params, unsigned int filter)
@ -776,7 +782,7 @@ size_t snd_timer_status_sizeof()
/**
* \brief allocate a new snd_timer_status_t structure
* \param ptr returned pointer
* \param status returned pointer
* \return 0 on success otherwise a negative error code if fails
*
* Allocates a new snd_timer_status_t structure using the standard

6
src/timer/timer_local.h
View file

@ -24,6 +24,7 @@
#include <limits.h>
#include "local.h"
#ifndef DOC_HIDDEN
typedef struct {
int (*close)(snd_timer_t *timer);
int (*nonblock)(snd_timer_t *timer, int nonblock);
@ -48,8 +49,6 @@ struct _snd_timer {
struct list_head async_handlers;
};
int snd_timer_hw_open(snd_timer_t **handle, const char *name, int dev_class, int dev_sclass, int card, int device, int subdevice, int mode);
typedef struct {
int (*close)(snd_timer_query_t *timer);
int (*next_device)(snd_timer_query_t *timer, snd_timer_id_t *tid);
@ -66,6 +65,9 @@ struct _snd_timer_query {
snd_timer_query_ops_t *ops;
void *private_data;
};
#endif /* DOC_HIDDEN */
int snd_timer_hw_open(snd_timer_t **handle, const char *name, int dev_class, int dev_sclass, int card, int device, int subdevice, int mode);
int snd_timer_query_hw_open(snd_timer_query_t **handle, const char *name, int mode);

13
src/timer/timer_query.c
View file

@ -231,7 +231,7 @@ size_t snd_timer_ginfo_sizeof(void)
/**
* \brief allocate a new snd_timer_ginfo_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_timer_info_t structure using the standard
@ -273,6 +273,7 @@ void snd_timer_ginfo_copy(snd_timer_ginfo_t *dst, const snd_timer_ginfo_t *src)
/**
* \brief set timer identification
* \param obj pointer to #snd_timer_ginfo_t structure
* \param tid pointer to #snd_timer_id_t structure
* \return zero on success otherwise a negative error number
*/
int snd_timer_ginfo_set_tid(snd_timer_ginfo_t *obj, snd_timer_id_t *tid)
@ -436,7 +437,7 @@ size_t snd_timer_id_sizeof()
/**
* \brief allocate a new snd_timer_id_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_timer_id_t structure using the standard
@ -510,7 +511,7 @@ void snd_timer_id_set_sclass(snd_timer_id_t * tid, int dev_sclass)
/**
* \brief get timer sub-class
* \param params pointer to #snd_timer_id_t structure
* \param tid pointer to #snd_timer_id_t structure
* \return timer sub-class
*/
int snd_timer_id_get_sclass(snd_timer_id_t * tid)
@ -532,7 +533,7 @@ void snd_timer_id_set_card(snd_timer_id_t * tid, int card)
/**
* \brief get timer card
* \param params pointer to #snd_timer_id_t structure
* \param tid pointer to #snd_timer_id_t structure
* \return timer card number
*/
int snd_timer_id_get_card(snd_timer_id_t * tid)
@ -554,7 +555,7 @@ void snd_timer_id_set_device(snd_timer_id_t * tid, int device)
/**
* \brief get timer device
* \param params pointer to #snd_timer_id_t structure
* \param tid pointer to #snd_timer_id_t structure
* \return timer device number
*/
int snd_timer_id_get_device(snd_timer_id_t * tid)
@ -576,7 +577,7 @@ void snd_timer_id_set_subdevice(snd_timer_id_t * tid, int subdevice)
/**
* \brief get timer subdevice
* \param params pointer to #snd_timer_id_t structure
* \param tid pointer to #snd_timer_id_t structure
* \return timer subdevice number
*/
int snd_timer_id_get_subdevice(snd_timer_id_t * tid)