doc: fix some missing parameter warnings

Where both declaration and definition are documented, drop one and rely on the
other. Drop the obvious documentations where not needed, doxygen wants either
none or all parameters documented.
This commit is contained in:
Peter Hutterer 2021-05-21 10:04:33 +10:00
parent ac9de03672
commit 1567dd4e3a
8 changed files with 22 additions and 14 deletions

View file

@ -148,7 +148,7 @@ struct pw_work_queue *pw_context_get_work_queue(struct pw_context *context);
* 0 to fetch the next item, any other value stops the iteration and returns * 0 to fetch the next item, any other value stops the iteration and returns
* the value. When all callbacks return 0, this function returns 0 when all * the value. When all callbacks return 0, this function returns 0 when all
* globals are iterated. */ * globals are iterated. */
int pw_context_for_each_global(struct pw_context *context, /**< the context */ int pw_context_for_each_global(struct pw_context *context,
int (*callback) (void *data, struct pw_global *global), int (*callback) (void *data, struct pw_global *global),
void *data); void *data);

View file

@ -515,15 +515,18 @@ pw_context_connect(struct pw_context *context, /**< a \ref pw_context */
size_t user_data_size /**< extra user data size */); size_t user_data_size /**< extra user data size */);
/** Connect to a PipeWire instance on the given socket \memberof pw_core /** Connect to a PipeWire instance on the given socket \memberof pw_core
* \param context a \ref pw_context
* \param fd the connected socket to use, the socket will be closed * \param fd the connected socket to use, the socket will be closed
* automatically on disconnect or error. * automatically on disconnect or error.
* \return a pw_core on success or NULL with errno set on error */ * \param properties optional properties, ownership of the properties is
* taken.
* \param user_data_size extra user data size
* \return a \ref pw_core on success or NULL with errno set on error */
struct pw_core * struct pw_core *
pw_context_connect_fd(struct pw_context *context, /**< a \ref pw_context */ pw_context_connect_fd(struct pw_context *context,
int fd, /**< an fd */ int fd,
struct pw_properties *properties, /**< optional properties, ownership of struct pw_properties *properties,
* the properties is taken.*/ size_t user_data_size);
size_t user_data_size /**< extra user data size */);
/** Connect to a given PipeWire instance \memberof pw_core /** Connect to a given PipeWire instance \memberof pw_core
* \return a pw_core on success or NULL with errno set on error */ * \return a pw_core on success or NULL with errno set on error */

View file

@ -170,7 +170,7 @@ pw_filter_get_node_id(struct pw_filter *filter);
int pw_filter_disconnect(struct pw_filter *filter); int pw_filter_disconnect(struct pw_filter *filter);
/** add a port to the filter, returns user data of port_data_size. */ /** add a port to the filter, returns user data of port_data_size. */
void *pw_filter_add_port(struct pw_filter *filter, void *pw_filter_add_port(struct pw_filter *filter, /**< a \ref pw_filter */
enum pw_direction direction, /**< port direction */ enum pw_direction direction, /**< port direction */
enum pw_filter_port_flags flags, /**< port flags */ enum pw_filter_port_flags flags, /**< port flags */
size_t port_data_size, /**< allocated and given to the user as port_data */ size_t port_data_size, /**< allocated and given to the user as port_data */
@ -193,7 +193,9 @@ int pw_filter_update_properties(struct pw_filter *filter,
/** Set the filter in error state */ /** Set the filter in error state */
int pw_filter_set_error(struct pw_filter *filter, /**< a \ref pw_filter */ int pw_filter_set_error(struct pw_filter *filter, /**< a \ref pw_filter */
int res, /**< a result code */ int res, /**< a result code */
const char *error, ... /**< an error message */) SPA_PRINTF_FUNC(3, 4); const char *error, /**< an error message */
...
) SPA_PRINTF_FUNC(3, 4);
/** Update params, use NULL port_data for global filter params */ /** Update params, use NULL port_data for global filter params */
int int

View file

@ -267,6 +267,7 @@ void pw_global_add_listener(struct pw_global *global,
* *
* \param global the global to bind to * \param global the global to bind to
* \param client the client that binds * \param client the client that binds
* \param permissions the \ref pw_permission
* \param version the version * \param version the version
* \param id the id of the resource * \param id the id of the resource
* *

View file

@ -55,7 +55,7 @@ struct pw_global;
#include <pipewire/impl.h> #include <pipewire/impl.h>
typedef int (*pw_global_bind_func_t) (void *object, typedef int (*pw_global_bind_func_t) (void *object, /**< global object, see \ref pw_global_new */
struct pw_impl_client *client, /**< client that binds */ struct pw_impl_client *client, /**< client that binds */
uint32_t permissions, /**< permissions for the bind */ uint32_t permissions, /**< permissions for the bind */
uint32_t version, /**< client interface version */ uint32_t version, /**< client interface version */

View file

@ -149,6 +149,7 @@ static const struct pw_global_events global_events = {
* \param context a \ref pw_context * \param context a \ref pw_context
* \param name name of the module to load * \param name name of the module to load
* \param args A string with arguments for the module * \param args A string with arguments for the module
* \param properties extra global properties
* \return A \ref pw_impl_module if the module could be loaded, or NULL on failure. * \return A \ref pw_impl_module if the module could be loaded, or NULL on failure.
* *
* \memberof pw_impl_module * \memberof pw_impl_module

View file

@ -75,9 +75,9 @@ struct pw_impl_module_events {
struct pw_impl_module * struct pw_impl_module *
pw_context_load_module(struct pw_context *context, pw_context_load_module(struct pw_context *context,
const char *name, /**< name of the module */ const char *name,
const char *args /**< arguments of the module */, const char *args,
struct pw_properties *properties /**< extra global properties */); struct pw_properties *properties);
/** Get the context of a module */ /** Get the context of a module */
struct pw_context * pw_impl_module_get_context(struct pw_impl_module *module); struct pw_context * pw_impl_module_get_context(struct pw_impl_module *module);

View file

@ -315,7 +315,8 @@ int pw_stream_disconnect(struct pw_stream *stream);
/** Set the stream in error state */ /** Set the stream in error state */
int pw_stream_set_error(struct pw_stream *stream, /**< a \ref pw_stream */ int pw_stream_set_error(struct pw_stream *stream, /**< a \ref pw_stream */
int res, /**< a result code */ int res, /**< a result code */
const char *error, ... /**< an error message */) SPA_PRINTF_FUNC(3, 4); const char *error, /**< an error message */
...) SPA_PRINTF_FUNC(3, 4);
/** Complete the negotiation process with result code \a res \memberof pw_stream /** Complete the negotiation process with result code \a res \memberof pw_stream
* *