properties: try to keep full doxygen docs out of headers

Try to keep the full docs out of the headers and into the .c file.
A small short blurb in the header is enough for quick lookups.
Also try to use a regular comment to not confuse the doc system.
This commit is contained in:
Wim Taymans 2021-06-04 12:08:23 +02:00
parent 2e6621fae0
commit a2cb5f3394

View file

@ -68,24 +68,13 @@ int pw_properties_update_keys(struct pw_properties *props,
int pw_properties_update_ignore(struct pw_properties *props,
const struct spa_dict *dict, const char *ignore[]);
int pw_properties_update(struct pw_properties *oldprops,
/* Update props with all key/value pairs from dict */
int pw_properties_update(struct pw_properties *props,
const struct spa_dict *dict);
/**
* Update the properties from the given string updating \a props to
* - all key/value pairs from \a str
* - all key/value pairs from \a props that were not given in \a str
*
* \return The number of properties added or updated
*/
/* Update props with all key/value pairs from str */
int pw_properties_update_string(struct pw_properties *props,
const char *str, size_t size);
/**
* Update the properties from the given string updating \a props to
* - all key/value pairs from \a props
* - all key/value pairs from \a str that were not given in \a str
*
* \return The number of properties added
*/
/* Update props with only new key/value from str */
int pw_properties_add_string(struct pw_properties *props,
const char *str, size_t size);