[27498] in CVS-changelog-for-Kerberos-V5
krb5 commit: Better doxygen markup for RESPONDER_QUESTION_OTP
daemon@ATHENA.MIT.EDU (Zhanna A Tsitkova)
Fri Jan 11 15:58:46 2013
Date: Fri, 11 Jan 2013 15:58:45 -0500
From: Zhanna A Tsitkova <tsitkova@mit.edu>
Message-Id: <201301112058.r0BKwj3I014204@drugstore.mit.edu>
To: cvs-krb5@mit.edu
Reply-To: krbdev@mit.edu
MIME-Version: 1.0
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7bit
Errors-To: cvs-krb5-bounces@mit.edu
https://github.com/krb5/krb5/commit/4382911e52c37f0b7efd3664505a9c7263c9d79a
commit 4382911e52c37f0b7efd3664505a9c7263c9d79a
Author: Zhanna Tsitkov <tsitkova@mit.edu>
Date: Fri Jan 11 15:40:28 2013 -0500
Better doxygen markup for RESPONDER_QUESTION_OTP
Doxygen and, consequently, Sphinx gets confused with the
KRB5_RESPONDER_QUESTION_OTP comment layout.
Also, mark the output parameter of krb5_responder_set_answer().
src/include/krb5/krb5.hin | 44 +++++++++++++++++++++++---------------------
1 files changed, 23 insertions(+), 21 deletions(-)
diff --git a/src/include/krb5/krb5.hin b/src/include/krb5/krb5.hin
index 68ae888..8f8ef7e 100644
--- a/src/include/krb5/krb5.hin
+++ b/src/include/krb5/krb5.hin
@@ -6380,28 +6380,30 @@ krb5_prompter_posix(krb5_context context, void *data, const char *name,
* The OTP responder question is asked when the KDC indicates that an OTP
* value is required in order to complete the authentication. The JSON format
* of the challenge is:
- * {
- * "service": <string (optional)>,
- * "tokenInfo": [
- * {
- * "flags": <number>,
- * "vendor": <string (optional)>,
- * "challenge": <string (optional)>,
- * "length": <number (optional)>,
- * "format": <number (optional)>,
- * "tokenID": <string (optional)>,
- * "algID": <string (optional)>,
- * },
- * ...
- * ]
- * }
+ *
+ * @n {
+ * @n "service": <string (optional)>,
+ * @n "tokenInfo": [
+ * @n {
+ * @n "flags": <number>,
+ * @n "vendor": <string (optional)>,
+ * @n "challenge": <string (optional)>,
+ * @n "length": <number (optional)>,
+ * @n "format": <number (optional)>,
+ * @n "tokenID": <string (optional)>,
+ * @n "algID": <string (optional)>,
+ * @n },
+ * @n ...
+ * @n ]
+ * @n }
*
* The answer to the question MUST be JSON formatted:
- * {
- * "tokeninfo": <number>,
- * "value": <string (optional)>,
- * "pin": <string (optional)>,
- * }
+ *
+ * @n {
+ * @n "tokeninfo": <number>,
+ * @n "value": <string (optional)>,
+ * @n "pin": <string (optional)>,
+ * @n }
*
* For more detail, please see RFC 6560.
*
@@ -6472,7 +6474,7 @@ krb5_responder_get_challenge(krb5_context ctx, krb5_responder_context rctx,
* Answer a named question in the responder context.
*
* @param [in] ctx Library context
- * @param [in] rctx Responder context
+ * @param [in,out] rctx Responder context
* @param [in] question Question name
* @param [in] answer The string to set (MUST be printable UTF-8)
*
_______________________________________________
cvs-krb5 mailing list
cvs-krb5@mit.edu
https://mailman.mit.edu/mailman/listinfo/cvs-krb5
