pipewire: drop \memberof declarations

This is obsolete since the move to doxygen groups and having \memberof blocked
the documentation in the source file from being merged with the header file.
This commit is contained in:
Peter Hutterer 2021-06-21 16:40:30 +10:00 committed by Wim Taymans
parent a4bdf83e39
commit 0a5ae1cf47
8 changed files with 12 additions and 45 deletions

View file

@ -42,7 +42,7 @@ extern "C" {
#define PW_VERSION_FACTORY 3
struct pw_factory;
/** The factory information. Extra information can be added in later versions \memberof pw_introspect */
/** The factory information. Extra information can be added in later versions */
struct pw_factory_info {
uint32_t id; /**< id of the global */
const char *name; /**< name the factory */

View file

@ -54,7 +54,7 @@ extern "C" {
#define PW_VERSION_LINK 3
struct pw_link;
/** \enum pw_link_state The different link states \memberof pw_link */
/** \enum pw_link_state The different link states */
enum pw_link_state {
PW_LINK_STATE_ERROR = -2, /**< the link is in error */
PW_LINK_STATE_UNLINKED = -1, /**< the link is unlinked */
@ -67,7 +67,7 @@ enum pw_link_state {
/** Convert a \ref pw_link_state to a readable string */
const char * pw_link_state_as_string(enum pw_link_state state);
/** The link information. Extra information can be added in later versions \memberof pw_introspect */
/** The link information. Extra information can be added in later versions */
struct pw_link_info {
uint32_t id; /**< id of the global */
uint32_t output_node_id; /**< server side output node id */

View file

@ -49,7 +49,6 @@ struct impl {
/** Create a new loop
* \returns a newly allocated loop
* \memberof pw_loop
*/
SPA_EXPORT
struct pw_loop *pw_loop_new(const struct spa_dict *props)
@ -152,7 +151,6 @@ error_cleanup:
/** Destroy a loop
* \param loop a loop to destroy
* \memberof pw_loop
*/
SPA_EXPORT
void pw_loop_destroy(struct pw_loop *loop)

View file

@ -204,7 +204,6 @@ void pw_mempool_add_listener(struct pw_mempool *pool,
/** Map a memblock
* \param mem a memblock
* \return 0 on success, < 0 on error
* \memberof pw_memblock
*/
SPA_EXPORT
int pw_memblock_map_old(struct pw_memblock *mem)
@ -468,7 +467,6 @@ static inline enum pw_memmap_flags block_flags_to_mem(enum pw_memblock_flags fla
* \param type the requested memory type one of enum spa_data_type
* \param size size to allocate
* \return a memblock structure or NULL with errno on error
* \memberof pw_memblock
*/
SPA_EXPORT
struct pw_memblock * pw_mempool_alloc(struct pw_mempool *pool, enum pw_memblock_flags flags,
@ -693,7 +691,6 @@ int pw_mempool_remove_id(struct pw_mempool *pool, uint32_t id)
/** Free a memblock
* \param block a memblock
* \memberof pw_memblock
*/
SPA_EXPORT
void pw_memblock_free(struct pw_memblock *block)

View file

@ -52,7 +52,7 @@ extern "C" {
#define PW_VERSION_NODE 3
struct pw_node;
/** \enum pw_node_state The different node states \memberof pw_node */
/** \enum pw_node_state The different node states */
enum pw_node_state {
PW_NODE_STATE_ERROR = -1, /**< error state */
PW_NODE_STATE_CREATING = 0, /**< the node is being created */
@ -66,7 +66,7 @@ enum pw_node_state {
/** Convert a \ref pw_node_state to a readable string */
const char * pw_node_state_as_string(enum pw_node_state state);
/** The node information. Extra information can be added in later versions \memberof pw_introspect */
/** The node information. Extra information can be added in later versions */
struct pw_node_info {
uint32_t id; /**< id of the global */
uint32_t max_input_ports; /**< maximum number of inputs */

View file

@ -1144,10 +1144,10 @@ int pw_impl_port_release_mix(struct pw_impl_port *port, struct pw_impl_port_mix
void pw_impl_port_update_state(struct pw_impl_port *port, enum pw_impl_port_state state, int res, char *error);
/** Unlink a port \memberof pw_impl_port */
/** Unlink a port */
void pw_impl_port_unlink(struct pw_impl_port *port);
/** Destroy a port \memberof pw_impl_port */
/** Destroy a port */
void pw_impl_port_destroy(struct pw_impl_port *port);
/** Iterate the params of the given port. The callback should return
@ -1181,12 +1181,12 @@ int pw_impl_port_for_each_link(struct pw_impl_port *port,
int (*callback) (void *data, struct pw_impl_link *link),
void *data);
/** Set a param on a port \memberof pw_impl_port, use SPA_ID_INVALID for mix_id to set
/** Set a param on a port, use SPA_ID_INVALID for mix_id to set
* the param on all mix ports */
int pw_impl_port_set_param(struct pw_impl_port *port,
uint32_t id, uint32_t flags, const struct spa_pod *param);
/** Use buffers on a port \memberof pw_impl_port */
/** Use buffers on a port */
int pw_impl_port_use_buffers(struct pw_impl_port *port, struct pw_impl_port_mix *mix, uint32_t flags,
struct spa_buffer **buffers, uint32_t n_buffers);
@ -1202,13 +1202,13 @@ int pw_impl_node_update_ports(struct pw_impl_node *node);
int pw_impl_node_set_driver(struct pw_impl_node *node, struct pw_impl_node *driver);
/** Prepare a link \memberof pw_impl_link
/** Prepare a link
* Starts the negotiation of formats and buffers on \a link */
int pw_impl_link_prepare(struct pw_impl_link *link);
/** starts streaming on a link */
int pw_impl_link_activate(struct pw_impl_link *link);
/** Deactivate a link \memberof pw_impl_link */
/** Deactivate a link */
int pw_impl_link_deactivate(struct pw_impl_link *link);
struct pw_control *

View file

@ -93,8 +93,6 @@ static struct properties *properties_new(int prealloc)
* \param key a first key
* \param ... value and more keys NULL terminated
* \return a newly allocated properties object
*
* \memberof pw_properties
*/
SPA_EXPORT
struct pw_properties *pw_properties_new(const char *key, ...)
@ -123,8 +121,6 @@ struct pw_properties *pw_properties_new(const char *key, ...)
*
* \param dict a dictionary. keys and values are copied
* \return a new properties object
*
* \memberof pw_properties
*/
SPA_EXPORT
struct pw_properties *pw_properties_new_dict(const struct spa_dict *dict)
@ -195,8 +191,6 @@ int pw_properties_update_string(struct pw_properties *props, const char *str, si
*
* \param object a property description
* \return a new properties object
*
* \memberof pw_properties
*/
SPA_EXPORT
struct pw_properties *
@ -223,8 +217,6 @@ error:
*
* \param properties properties to copy
* \return a new properties object
*
* \memberof pw_properties
*/
SPA_EXPORT
struct pw_properties *pw_properties_copy(const struct pw_properties *properties)
@ -238,8 +230,6 @@ struct pw_properties *pw_properties_copy(const struct pw_properties *properties)
* \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
*
* \memberof pw_properties
*/
SPA_EXPORT
int pw_properties_update_keys(struct pw_properties *props,
@ -282,8 +272,6 @@ int pw_properties_update_ignore(struct pw_properties *props,
/** Clear a properties object
*
* \param properties properties to clear
*
* \memberof pw_properties
*/
SPA_EXPORT
void pw_properties_clear(struct pw_properties *properties)
@ -305,8 +293,6 @@ void pw_properties_clear(struct pw_properties *properties)
*
* The properties in \a props are updated with \a dict. Keys in \a dict
* with NULL values are removed from \a props.
*
* \memberof pw_properties
*/
SPA_EXPORT
int pw_properties_update(struct pw_properties *props,
@ -328,8 +314,6 @@ int pw_properties_update(struct pw_properties *props,
* \return the number of added properties
*
* The properties from \a dict that are not yet in \a props are added.
*
* \memberof pw_properties
*/
SPA_EXPORT
int pw_properties_add(struct pw_properties *props,
@ -354,8 +338,6 @@ int pw_properties_add(struct pw_properties *props,
*
* The properties with \a keys from \a dict that are not yet
* in \a props are added.
*
* \memberof pw_properties
*/
SPA_EXPORT
int pw_properties_add_keys(struct pw_properties *props,
@ -377,8 +359,6 @@ int pw_properties_add_keys(struct pw_properties *props,
/** Free a properties object
*
* \param properties the properties to free
*
* \memberof pw_properties
*/
SPA_EXPORT
void pw_properties_free(struct pw_properties *properties)
@ -450,8 +430,6 @@ exit_noupdate:
* Set the property in \a properties with \a key to \a value. Any previous value
* of \a key will be overwritten. When \a value is NULL, the key will be
* removed.
*
* \memberof pw_properties
*/
SPA_EXPORT
int pw_properties_set(struct pw_properties *properties, const char *key, const char *value)
@ -483,8 +461,6 @@ int pw_properties_setva(struct pw_properties *properties,
*
* Set the property in \a properties with \a key to the value in printf style \a format
* Any previous value of \a key will be overwritten.
*
* \memberof pw_properties
*/
SPA_EXPORT
int pw_properties_setf(struct pw_properties *properties, const char *key, const char *format, ...)
@ -506,8 +482,6 @@ int pw_properties_setf(struct pw_properties *properties, const char *key, const
* \return the property for \a key or NULL when the key was not found
*
* Get the property in \a properties with \a key.
*
* \memberof pw_properties
*/
SPA_EXPORT
const char *pw_properties_get(const struct pw_properties *properties, const char *key)
@ -531,8 +505,6 @@ const char *pw_properties_get(const struct pw_properties *properties, const char
* to a pointer holding NULL to get the first element and will be updated
* after each iteration. When NULL is returned, all elements have been
* iterated.
*
* \memberof pw_properties
*/
SPA_EXPORT
const char *pw_properties_iterate(const struct pw_properties *properties, void **state)

View file

@ -44,7 +44,7 @@ extern "C" {
* \{
*/
/** a function to destroy an item \memberof pw_utils */
/** a function to destroy an item */
typedef void (*pw_destroy_t) (void *object);
const char *