aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Hirche <daniel@xcx.cc>2017-11-15 11:55:39 +0100
committerCQ bot account: commit-bot@chromium.org <commit-bot@chromium.org>2017-11-15 14:23:11 +0000
commit74b828f263e0d811e37fbb20d4a9a1f04347ca03 (patch)
tree0f381a7107c5c6936f1d381cb704c6c0f9bdfe31
parente6f30e4ce133ff9e33c8d670a12ffb0ef051ddfc (diff)
downloadboringssl-74b828f263e0d811e37fbb20d4a9a1f04347ca03.zip
boringssl-74b828f263e0d811e37fbb20d4a9a1f04347ca03.tar.gz
boringssl-74b828f263e0d811e37fbb20d4a9a1f04347ca03.tar.bz2
Clarify the documentation for |BN_is_bit_set|.
Change-Id: Ic859f19edff281334bd6975dd3c3b2931c901021 Reviewed-on: https://boringssl-review.googlesource.com/23044 Reviewed-by: David Benjamin <davidben@google.com> Commit-Queue: David Benjamin <davidben@google.com> CQ-Verified: CQ bot account: commit-bot@chromium.org <commit-bot@chromium.org>
-rw-r--r--include/openssl/bn.h4
1 files changed, 2 insertions, 2 deletions
diff --git a/include/openssl/bn.h b/include/openssl/bn.h
index 9960b75..85fdae4 100644
--- a/include/openssl/bn.h
+++ b/include/openssl/bn.h
@@ -487,8 +487,8 @@ OPENSSL_EXPORT int BN_set_bit(BIGNUM *a, int n);
// zero on allocation failure.
OPENSSL_EXPORT int BN_clear_bit(BIGNUM *a, int n);
-// BN_is_bit_set returns the value of the |n|th, least-significant bit in |a|,
-// or zero if the bit doesn't exist.
+// BN_is_bit_set returns one if the |n|th least-significant bit in |a| exists
+// and is set. Otherwise, it returns zero.
OPENSSL_EXPORT int BN_is_bit_set(const BIGNUM *a, int n);
// BN_mask_bits truncates |a| so that it is only |n| bits long. It returns one