From 86b643a90c22e1bbf2b355ce0c2a659cba44db0a Mon Sep 17 00:00:00 2001
From: Alexandre Janniaux <ajanni@videolabs.io>
Date: Thu, 6 Jul 2023 11:48:43 +0200
Subject: [PATCH] vlc_keystore: fix doxygen warnings

    include/vlc_keystore.h:121: warning: The following parameter of vlc_keystore_find(vlc_keystore *p_keystore, const char *const ppsz_values[KEY_MAX], vlc_keystore_entry **pp_entries) is not documented:
      parameter 'p_keystore'

    include/vlc_keystore.h:136: warning: The following parameter of vlc_keystore_remove(vlc_keystore *p_keystore, const char *const ppsz_values[KEY_MAX]) is not documented:
      parameter 'p_keystore'

    include/vlc_keystore.h:102: warning: The following parameter of vlc_keystore_store(vlc_keystore *p_keystore, const char *const ppsz_values[KEY_MAX], const uint8_t *p_secret, ssize_t i_secret_len, const char *psz_label) is not documented:
      parameter 'p_keystore'

    include/vlc_keystore.h:219: warning: The following parameter of vlc_credential_get(vlc_credential *p_credential, vlc_object_t *p_parent, const char *psz_option_username, const char *psz_option_password, const char *psz_dialog_title, const char *psz_dialog_fmt,...) is not documented:
      parameter 'p_credential'

    include/vlc_keystore.h:203: warning: argument 'psz_url' of command @param is not found in the argument list of vlc_credential_init(vlc_credential *p_credential, const vlc_url_t *p_url)

    include/vlc_keystore.h:203: warning: The following parameters of vlc_credential_init(vlc_credential *p_credential, const vlc_url_t *p_url) are not documented:
      parameter 'p_credential'
      parameter 'p_url'
---
 include/vlc_keystore.h | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/include/vlc_keystore.h b/include/vlc_keystore.h
index c81c1c7cfc..fb138b4ab9 100644
--- a/include/vlc_keystore.h
+++ b/include/vlc_keystore.h
@@ -100,6 +100,7 @@ vlc_keystore_release(vlc_keystore *p_keystore);
 /**
  * Store a secret associated with a set of key/values
  *
+ * @param p_keystore the keystore to store the secret into
  * @param ppsz_values set of key/values, see vlc_keystore_key.
  *        ppsz_values[KEY_PROTOCOL] and  ppsz_values[KEY_SERVER] must be valid
  *        strings
@@ -119,6 +120,7 @@ vlc_keystore_store(vlc_keystore *p_keystore,
 /**
  * Find all entries that match a set of key/values
  *
+ * @param p_keystore the keystore instance to look into
  * @param ppsz_values set of key/values, see vlc_keystore_key, any values can
  * be NULL
  * @param pp_entries list of found entries. To be released with
@@ -136,6 +138,7 @@ vlc_keystore_find(vlc_keystore *p_keystore,
  *
  * @note only entries added by VLC can be removed
  *
+ * @param p_keystore the keystore instance to remove the secrets from
  * @param ppsz_values set of key/values, see vlc_keystore_key, any values can
  * be NULL
  *
@@ -203,7 +206,8 @@ struct vlc_credential
  *
  * @note to be cleaned with vlc_credential_clean()
  *
- * @param psz_url url to store or to search
+ * @param p_credential a credential instance to initialize
+ * @param p_url url to store or to search
  */
 VLC_API void
 vlc_credential_init(vlc_credential *p_credential, const vlc_url_t *p_url);
@@ -224,6 +228,7 @@ vlc_credential_clean(vlc_credential *p_credential);
  * from the dialog (if any). This function will return true as long as the user
  * fill the dialog texts and will return false when the user cancel it.
  *
+ * @param p_credential a credential instance initialized with TODO
  * @param p_parent the parent object (for var, keystore and dialog)
  * @param psz_option_username VLC option name for the username
  * @param psz_option_password VLC option name for the password