From 95219feafda9100a37ee17f54246d6706cee4498 Mon Sep 17 00:00:00 2001 From: David Benjamin Date: Thu, 21 Jan 2016 16:29:21 -0500 Subject: [PATCH] Fix some documentation comments. The new OPENSSL_PRINTF_FORMAT_FUNC macro let doc.go catch a few problems. It also confuses doc.go, but this CL doesn't address that. At some point we probably need to give it a real C parser. Change-Id: I39f945df04520d1e0a0ba390cac7b308baae0622 Reviewed-on: https://boringssl-review.googlesource.com/6940 Reviewed-by: Adam Langley --- include/openssl/bio.h | 8 ++++---- include/openssl/mem.h | 7 ++----- 2 files changed, 6 insertions(+), 9 deletions(-) diff --git a/include/openssl/bio.h b/include/openssl/bio.h index 0c8bfe405..3447f5bfe 100644 --- a/include/openssl/bio.h +++ b/include/openssl/bio.h @@ -308,10 +308,10 @@ OPENSSL_EXPORT BIO *BIO_find_type(BIO *bio, int type); OPENSSL_EXPORT void BIO_copy_next_retry(BIO *bio); -/* Printf functions. - * - * These functions are versions of printf functions that output to a BIO rather - * than a FILE. */ +/* Printf functions. */ + +/* BIO_printf behaves like |printf| but outputs to |bio| rather than a |FILE|. + * It returns the number of bytes written or a negative number on error. */ OPENSSL_EXPORT int BIO_printf(BIO *bio, const char *format, ...) OPENSSL_PRINTF_FORMAT_FUNC(2, 3); diff --git a/include/openssl/mem.h b/include/openssl/mem.h index 46d75d12b..ba48f078a 100644 --- a/include/openssl/mem.h +++ b/include/openssl/mem.h @@ -114,14 +114,11 @@ OPENSSL_EXPORT int OPENSSL_strncasecmp(const char *a, const char *b, size_t n); * representation of the given type. */ #define DECIMAL_SIZE(type) ((sizeof(type)*8+2)/3+1) -/* Printf functions. - * - * These functions are either OpenSSL wrappers for standard functions (i.e. - * |BIO_snprintf| and |BIO_vsnprintf|) which don't exist in C89, or are - * versions of printf functions that output to a BIO rather than a FILE. */ +/* BIO_snprintf has the same behavior as snprintf(3). */ OPENSSL_EXPORT int BIO_snprintf(char *buf, size_t n, const char *format, ...) OPENSSL_PRINTF_FORMAT_FUNC(3, 4); +/* BIO_vsnprintf has the same behavior as vsnprintf(3). */ OPENSSL_EXPORT int BIO_vsnprintf(char *buf, size_t n, const char *format, va_list args) OPENSSL_PRINTF_FORMAT_FUNC(3, 0);