From 664abd356b20e07be947af0cfd80fe49efd03a3a Mon Sep 17 00:00:00 2001 From: Zhanna Tsitkov Date: Tue, 8 Feb 2011 21:25:21 +0000 Subject: [PATCH] Set JAVADOC_AUTOBRIEF to YES to allow Doxygen interpret the first line of a JavaDoc-style comment as the brief description. Also, minor argument name fix in krb5.hin git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@24617 dc483132-0cff-0310-8789-dd5450dbe970 --- src/Doxyfile | 4 ++-- src/include/krb5/krb5.hin | 15 ++++++--------- 2 files changed, 8 insertions(+), 11 deletions(-) diff --git a/src/Doxyfile b/src/Doxyfile index 35bfe7378..28f5ab4ce 100644 --- a/src/Doxyfile +++ b/src/Doxyfile @@ -147,7 +147,7 @@ SHORT_NAMES = NO # comments will behave just like regular Qt-style comments # (thus requiring an explicit @brief command for a brief description.) -JAVADOC_AUTOBRIEF = NO +JAVADOC_AUTOBRIEF = YES # If the QT_AUTOBRIEF tag is set to YES then Doxygen will # interpret the first line (until the first dot) of a Qt-style @@ -1273,7 +1273,7 @@ MAN_LINKS = NO # generate an XML file that captures the structure of # the code including all documentation. -GENERATE_XML = NO +GENERATE_XML = YES # The XML_OUTPUT tag is used to specify where the XML pages will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be diff --git a/src/include/krb5/krb5.hin b/src/include/krb5/krb5.hin index 14c4a9e41..713932b44 100644 --- a/src/include/krb5/krb5.hin +++ b/src/include/krb5/krb5.hin @@ -292,7 +292,7 @@ typedef const krb5_principal_data *krb5_const_principal; /* * Referral-specific functions. */ -krb5_boolean KRB5_CALLCONV krb5_is_referral_realm(const krb5_data *); +krb5_boolean KRB5_CALLCONV krb5_is_referral_realm(const krb5_data *r); /* Both these functions return constant storage that must not be freed. */ const krb5_data *KRB5_CALLCONV krb5_anonymous_realm(void); @@ -2806,8 +2806,8 @@ krb5_get_credentials_renew(krb5_context context, krb5_flags options, * @brief Format a @c KRB_AP_REQ message. * * @param context Context structure [input, output] - * @param auth_context Authentication context, containing the checksum method to be used; a new authentication contextis returned if NULL is specified. [input, output] - * @param in_data Application data with a checksum to be included in the authenticator; specify NULL if no checksum is to be included [input] + * @param auth_context Authentication context, containing the checksum method to be used; a new authentication contextis returned if NULL is specified. [input, output] + * @param in_data Application data with a checksum to be included in the authenticator; specify NULL if no checksum is to be included [input] * @param ap_req_options * @param service * @param hostname @@ -4186,8 +4186,6 @@ krb5_timeofday(krb5_context context, register krb5_timestamp *timeret); * @param context Context structure [input, output] * @param addr Pointer to array of address pointers [output] * - * - * * Compile-time configuration flags indicate which protocol family addresses * can be returned. * @@ -4208,7 +4206,6 @@ krb5_os_localaddr(krb5_context context, krb5_address ***addr); * @param context Context structure [input, output] * @param lrealm Pointer to default realm [output] * - * * Make sure to free the allocated memory when it is no longer needed. * * @retval @@ -5611,7 +5608,7 @@ krb5_string_to_timestamp(char *string, krb5_timestamp *timestampp); * @brief Convert a string to a delta time value. * * @param string Pointer to string to convert [input] - * @param deltap Pointer to delta time [output] + * @param deltatp Pointer to delta time [output] * * @retval * 0 Success @@ -5621,7 +5618,7 @@ krb5_string_to_timestamp(char *string, krb5_timestamp *timestampp); * Kerberos error codes */ krb5_error_code KRB5_CALLCONV -krb5_string_to_deltat(char *string, krb5_deltat *deltap); +krb5_string_to_deltat(char *string, krb5_deltat *deltatp); /** * @brief Convert a Kerberos encryption type value to a string. @@ -6551,7 +6548,7 @@ krb5_vset_error_message(krb5_context, krb5_error_code, const char *, va_list) #endif ; void KRB5_CALLCONV -krb5_copy_error_message(krb5_context, krb5_context); +krb5_copy_error_message (krb5_context dest_ctx, krb5_context src_ctx); /** * @brief Get extended error information. -- 2.26.2