[vlc-devel] [PATCHv3 3/7] sd: update services_discovery_AddSubItem documentation

[Rémi Denis-Courmont]

Le tiistaina 22. syyskuuta 2020, 15.09.54 EEST Thomas Guillem a écrit :
> ---
>  include/vlc_services_discovery.h | 5 +++++
>  1 file changed, 5 insertions(+)
> 
> diff --git a/include/vlc_services_discovery.h
> b/include/vlc_services_discovery.h index b88ca203487..cfdafa170f4 100644
> --- a/include/vlc_services_discovery.h
> +++ b/include/vlc_services_discovery.h
> @@ -180,6 +180,11 @@ static inline void
> services_discovery_AddItem(services_discovery_t *sd, * to alter the item
> later. However, if the caller will never remove nor alter * the item, it
> can drop its reference(s) immediately.
>   *
> + * @warning any update on the item after this call will be ignored by the
> + * receiver. The only solution to update an item is to remove and add it
> back.
> + * Implementing update callback support might be necessary if this
> case turns
> + * up too often.

This is as good as decreeing that the input item should be dereferenced 
immediately after it is added. In fact, it is as good as changing the API to 
have add_item consume the reference to the item.

> + *
>   * @param sd services discoverer / services discovery module instance
>   * @param item input item to add
>   */


-- 
レミ・デニ-クールモン
http://www.remlab.net/