doc: fix a few doxygen warnings about invalid arguments

This commit is contained in:
Peter Hutterer 2021-05-07 10:25:17 +10:00
parent f0d3f1f9d2
commit 4456fd3e18
6 changed files with 25 additions and 11 deletions

View file

@ -55,7 +55,7 @@ uint32_t pw_global_get_permissions(struct pw_global *global, struct pw_impl_clie
* \param type the type of the global
* \param version the version of the type
* \param properties extra properties
* \param bind a function to bind to this global
* \param func a function to bind to this global
* \param object the associated object
* \return a result global
*

View file

@ -371,7 +371,7 @@ static const struct pw_context_events context_events = {
/** Make a new client object
*
* \param context a \ref pw_context object to register the client with
* \param core a \ref pw_context object to register the client with
* \param ucred a ucred structure or NULL when unknown
* \param properties optional client properties, ownership is taken
* \return a newly allocated client object
@ -625,7 +625,7 @@ const struct pw_client_info *pw_impl_client_get_info(struct pw_impl_client *clie
/** Update client properties
*
* \param client the client
* \param dict a \ref spa_dict with properties
* \param dict a \struct spa_dict with properties
*
* Add all properties in \a dict to the client properties. Existing
* properties are overwritten. Items can be removed by setting the value

View file

@ -147,7 +147,6 @@ static const struct pw_global_events global_events = {
* \param context a \ref pw_context
* \param name name of the module to load
* \param args A string with arguments for the module
* \param[out] error Return location for an error string, or NULL
* \return A \ref pw_impl_module if the module could be loaded, or NULL on failure.
*
* \memberof pw_impl_module

View file

@ -685,7 +685,7 @@ int pw_mempool_remove_id(struct pw_mempool *pool, uint32_t id)
}
/** Free a memblock
* \param mem a memblock
* \param block a memblock
* \memberof pw_memblock
*/
SPA_EXPORT

View file

@ -183,10 +183,10 @@ int pw_properties_update_string(struct pw_properties *props, const char *str, si
/** Make a new properties object from the given str
*
* \a str should be a whitespace separated list of key=value
* \a object should be a whitespace separated list of key=value
* strings or a json object.
*
* \param args a property description
* \param object a property description
* \return a new properties object
*
* \memberof pw_properties
@ -227,8 +227,8 @@ struct pw_properties *pw_properties_copy(const struct pw_properties *properties)
/** Copy multiple keys from one property to another
*
* \param src properties to copy from
* \param dst properties to copy to
* \param props properties to copy to
* \param dict properties to copy from
* \param keys a NULL terminated list of keys to copy
* \return the number of keys changed in \a dest
*

View file

@ -163,11 +163,11 @@ clean_this:
/** Create a new \ref pw_thread_loop
*
* \param loop the loop to wrap
* \param name the name of the thread or NULL
* \param props a dict of properties for the thread loop
* \return a newly allocated \ref pw_thread_loop
*
* Make a new \ref pw_thread_loop that will run \a loop in
* Make a new \ref pw_thread_loop that will run in
* a thread with \a name.
*
* After this function you should probably call pw_thread_loop_start() to
@ -182,6 +182,21 @@ struct pw_thread_loop *pw_thread_loop_new(const char *name,
return loop_new(NULL, name, props);
}
/** Create a new \ref pw_thread_loop
*
* \param loop the loop to wrap
* \param name the name of the thread or NULL
* \param props a dict of properties for the thread loop
* \return a newly allocated \ref pw_thread_loop
*
* Make a new \ref pw_thread_loop that will run \a loop in
* a thread with \a name.
*
* After this function you should probably call pw_thread_loop_start() to
* actually start the thread
*
* \memberof pw_thread_loop
*/
SPA_EXPORT
struct pw_thread_loop *pw_thread_loop_new_full(struct pw_loop *loop,
const char *name, const struct spa_dict *props)