diff options
| author | David Benjamin <davidben@chromium.org> | 2016-01-22 00:29:21 +0300 |
|---|---|---|
| committer | Adam Langley <agl@google.com> | 2016-01-22 01:12:08 +0300 |
| commit | 95219feafda9100a37ee17f54246d6706cee4498 (patch) | |
| tree | 6c4980d156c60d8733e3c0d638a075ddd75d110c /include/openssl/bio.h | |
| parent | d3a4e280db4c963b5ab0afa02f21322b776ce8c0 (diff) | |
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 <agl@google.com>
Diffstat (limited to 'include/openssl/bio.h')
| -rw-r--r-- | include/openssl/bio.h | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/include/openssl/bio.h b/include/openssl/bio.h index 0c8bfe40..3447f5bf 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); |