mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2025-11-06 13:30:01 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

spa: fix few doxygen errors

Browse source
This commit is contained in:
Peter Hutterer 2021-05-21 10:35:43 +10:00
parent 7c4bfe5a15
commit 4cf18c92f8
3 changed files with 11 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

8
spa/include/spa/monitor/device.h
View file

@ -152,9 +152,9 @@ struct spa_device_methods {
* object_info event for each managed object on the new * object_info event for each managed object on the new
* listener. * listener.
* *
* \param device a #spa_device * \param object a \ref spa_device
* \param listener a listener * \param listener a listener
* \param events a #struct spa_device_events * \param events a struct \ref spa_device_events
* \param data data passed as first argument in functions of \a events * \param data data passed as first argument in functions of \a events
* \return 0 on success * \return 0 on success
* < 0 errno on error * < 0 errno on error
@ -188,7 +188,7 @@ struct spa_device_methods {
* *
* Parameters can be filtered by passing a non-NULL \a filter. * Parameters can be filtered by passing a non-NULL \a filter.
* *
* The result callback will be called at most \max times with a * The result callback will be called at most \a max times with a
* struct spa_result_device_params as the result. * struct spa_result_device_params as the result.
* *
* This function must be called from the main thread. * This function must be called from the main thread.
@ -220,7 +220,7 @@ struct spa_device_methods {
* *
* This function must be called from the main thread. * This function must be called from the main thread.
* *
* \param device a \ref spa_device * \param object \ref spa_device
* \param id the parameter id to configure * \param id the parameter id to configure
* \param flags additional flags * \param flags additional flags
* \param param the parameter to configure * \param param the parameter to configure

12
spa/include/spa/node/node.h
View file

@ -286,7 +286,7 @@ struct spa_node_methods {
* *
* \param node a #spa_node * \param node a #spa_node
* \param listener a listener * \param listener a listener
* \param events a #struct spa_node_events * \param events a struct \ref spa_node_events
* \param data data passed as first argument in functions of \a events * \param data data passed as first argument in functions of \a events
* \return 0 on success * \return 0 on success
* < 0 errno on error * < 0 errno on error
@ -435,7 +435,7 @@ struct spa_node_methods {
* This function must be called from the main thread. * This function must be called from the main thread.
* *
* \param node a spa_node * \param node a spa_node
* \param direction a #enum spa_direction * \param direction a enum \ref spa_direction
* \param port_id an unused port id * \param port_id an unused port id
* \param props extra properties * \param props extra properties
* \return 0 on success * \return 0 on success
@ -449,7 +449,7 @@ struct spa_node_methods {
* Remove a port with \a port_id. * Remove a port with \a port_id.
* *
* \param node a spa_node * \param node a spa_node
* \param direction a #enum spa_direction * \param direction a enum \ref spa_direction
* \param port_id a port id * \param port_id a port id
* \return 0 on success * \return 0 on success
* -EINVAL when node is NULL or when port_id is unknown or * -EINVAL when node is NULL or when port_id is unknown or
@ -499,12 +499,12 @@ struct spa_node_methods {
* *
* This function must be called from the main thread. * This function must be called from the main thread.
* *
* \param node a #struct spa_node * \param node a struct \ref spa_node
* \param direction a #enum spa_direction * \param direction a enum \ref spa_direction
* \param port_id the port to configure * \param port_id the port to configure
* \param id the parameter id to set * \param id the parameter id to set
* \param flags optional flags * \param flags optional flags
* \param param a #struct spa_pod with the parameter to set * \param param a struct \ref spa_pod with the parameter to set
* \return 0 on success * \return 0 on success
* 1 on success, the value of \a param might have been * 1 on success, the value of \a param might have been
* changed depending on \a flags and the final value can be found by * changed depending on \a flags and the final value can be found by

2
spa/include/spa/utils/hook.h
View file

@ -51,7 +51,7 @@ struct spa_callbacks {
void *data; void *data;
}; };
/** Check if a callback \c has method \m of version \v */ /** Check if a callback \a c has method \a m of version \a v */
#define SPA_CALLBACK_CHECK(c,m,v) ((c) && ((v) == 0 || (c)->version > (v)-1) && (c)->m) #define SPA_CALLBACK_CHECK(c,m,v) ((c) && ((v) == 0 || (c)->version > (v)-1) && (c)->m)
#define SPA_CALLBACKS_INIT(_funcs,_data) (struct spa_callbacks){ _funcs, _data, } #define SPA_CALLBACKS_INIT(_funcs,_data) (struct spa_callbacks){ _funcs, _data, }