mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2025-10-29 05:40:27 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: add \copydoc, \sa links for (struct methods) function/macros

Browse source 
Add manually cross-references for struct methods callback
macros/functions, in cases where they're too hard to parse for the
Doxygen input filter.
This commit is contained in:
Pauli Virtanen 2021-10-02 22:41:47 +03:00
parent 392b2f1f96
commit de7f78f4bd
2 changed files with 19 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

9
spa/include/spa/support/dbus.h
View file

@ -109,8 +109,14 @@ struct spa_dbus_connection {
_res; \
})
/** \copydoc spa_dbus_connection.get
* \sa spa_dbus_connection.get */
#define spa_dbus_connection_get(c) spa_dbus_connection_call_vp(c,get,0)
/** \copydoc spa_dbus_connection.destroy
* \sa spa_dbus_connection.destroy */
#define spa_dbus_connection_destroy(c) spa_dbus_connection_call(c,destroy,0)
/** \copydoc spa_dbus_connection.add_listener
* \sa spa_dbus_connection.add_listener */
#define spa_dbus_connection_add_listener(c,...) spa_dbus_connection_call(c,add_listener,1,__VA_ARGS__)
struct spa_dbus_methods {
@ -133,6 +139,9 @@ struct spa_dbus_methods {
enum spa_dbus_type type);
};
/** \copydoc spa_dbus_methods.get_connection
* \sa spa_dbus_methods.get_connection
*/
static inline struct spa_dbus_connection *
spa_dbus_get_connection(struct spa_dbus *dbus, enum spa_dbus_type type)
{

10
spa/include/spa/support/thread.h
View file

@ -70,6 +70,8 @@ struct spa_thread_utils_methods {
int (*drop_rt) (void *data, struct spa_thread *thread);
};
/** \copydoc spa_thread_utils_methods.create
* \sa spa_thread_utils_methods.create */
static inline struct spa_thread *spa_thread_utils_create(struct spa_thread_utils *o,
const struct spa_dict *props, void *(*start_routine)(void*), void *arg)
{
@ -80,6 +82,8 @@ static inline struct spa_thread *spa_thread_utils_create(struct spa_thread_utils
return res;
}
/** \copydoc spa_thread_utils_methods.join
* \sa spa_thread_utils_methods.join */
static inline int spa_thread_utils_join(struct spa_thread_utils *o,
struct spa_thread *thread, void **retval)
{
@ -90,6 +94,8 @@ static inline int spa_thread_utils_join(struct spa_thread_utils *o,
return res;
}
/** \copydoc spa_thread_utils_methods.get_rt_range
* \sa spa_thread_utils_methods.get_rt_range */
static inline int spa_thread_utils_get_rt_range(struct spa_thread_utils *o,
const struct spa_dict *props, int *min, int *max)
{
@ -100,6 +106,8 @@ static inline int spa_thread_utils_get_rt_range(struct spa_thread_utils *o,
return res;
}
/** \copydoc spa_thread_utils_methods.acquire_rt
* \sa spa_thread_utils_methods.acquire_rt */
static inline int spa_thread_utils_acquire_rt(struct spa_thread_utils *o,
struct spa_thread *thread, int priority)
{
@ -110,6 +118,8 @@ static inline int spa_thread_utils_acquire_rt(struct spa_thread_utils *o,
return res;
}
/** \copydoc spa_thread_utils_methods.drop_rt
* \sa spa_thread_utils_methods.drop_rt */
static inline int spa_thread_utils_drop_rt(struct spa_thread_utils *o,
struct spa_thread *thread)
{