Do not reference krb5_chpw_result_code_string in
authorGreg Hudson <ghudson@mit.edu>
Mon, 25 Apr 2011 16:44:16 +0000 (16:44 +0000)
committerGreg Hudson <ghudson@mit.edu>
Mon, 25 Apr 2011 16:44:16 +0000 (16:44 +0000)
krb5_change_password() documentation, as it is not a public function.
Do not falsely claim that the result_code_string parameter is unused.

git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@24898 dc483132-0cff-0310-8789-dd5450dbe970

src/include/krb5/krb5.hin

index 89c3481adc6a6b496a62a932fd89f2c4518902d4..0bfe1c388fc8e4bc699f6b457adc231c2daf766c 100644 (file)
@@ -4362,7 +4362,7 @@ krb5_sname_match(krb5_context context, krb5_const_principal matching,
  * @param [in]  creds                   Kerberos credentials to the kadmin/changepw service
  * @param [in]  newpw                   New password
  * @param [out] result_code             A numeric error code
- * @param       result_code_string      (unused) String equivalent to @a result_code
+ * @param [out] result_code_string      String equivalent to @a result_code
  * @param [out] result_string           Change password response from the KDC
  *
  * Change the password for the existing principal identified by @a creds.
@@ -4375,8 +4375,6 @@ krb5_sname_match(krb5_context context, krb5_const_principal matching,
  * @li KRB5_KPASSWD_AUTHERROR (3) - Authentication error
  * @li KRB5_KPASSWD_SOFTERROR (4) - Password change rejected
  *
- * @sa krb5_chpw_result_code_string()
- *
  * @retval
  * 0  Success
  * @return