auth: fix docs for cli_credentials_get_password_and_obtained()

Signed-off-by: Douglas Bagnall <douglas.bagnall@catalyst.net.nz>
Reviewed-by: Jennifer Sutton <jennifersutton@catalyst.net.nz>

diff --git a/auth/credentials/credentials.c b/auth/credentials/credentials.c
index dab1c047c13b31e0edece8f00cea7a59bc80d45f..a8e3e22002fb64ecb37581b1af7e6cd1e81057ba 100644 (file)
--- a/auth/credentials/credentials.c
+++ b/auth/credentials/credentials.c
@@ -626,7 +626,7 @@ cli_credentials_get_password_obtained(struct cli_credentials *cred)
  *
  * @param[in]  obtained  A pointer to store the obtained information.
  *
- * return The user name or NULL if an error occurred.
+ * return The password if there is one.
  */
 _PUBLIC_ const char *
 cli_credentials_get_password_and_obtained(struct cli_credentials *cred,