From 5e97d0a489e31fc2fcbb552bda4257534cb9d964 Mon Sep 17 00:00:00 2001
From: Jack Lloyd <jack@randombit.net>
Date: Thu, 13 Sep 2018 10:12:17 -0400
Subject: Some document fixes

Downgrade min Sphinx to 1.2 again - I checked and while Sphinx 1.2
produce many warnings it does generate usable output.
---
 src/build-data/botan.doxy.in |  1 +
 src/configs/sphinx/conf.py   |  2 +-
 src/lib/ffi/ffi.h            | 21 +++++++++++++--------
 3 files changed, 15 insertions(+), 9 deletions(-)

(limited to 'src')

diff --git a/src/build-data/botan.doxy.in b/src/build-data/botan.doxy.in
index c3261a7a9..743a6e0b4 100644
--- a/src/build-data/botan.doxy.in
+++ b/src/build-data/botan.doxy.in
@@ -157,6 +157,7 @@ PREDEFINED             = BOTAN_HAS_AES_ARMV8 \
                          BOTAN_HAS_AES_POWER8 \
                          BOTAN_HAS_AES_SSSE3 \
                          BOTAN_HAS_CHACHA_SSE2 \
+                         BOTAN_HAS_CHACHA_AVX2 \
                          BOTAN_HAS_IDEA_SSE2 \
                          BOTAN_HAS_NOEKEON_SIMD \
                          BOTAN_HAS_SERPENT_SIMD \
diff --git a/src/configs/sphinx/conf.py b/src/configs/sphinx/conf.py
index c172f9411..127fd5401 100644
--- a/src/configs/sphinx/conf.py
+++ b/src/configs/sphinx/conf.py
@@ -47,7 +47,7 @@ version_patch = version_info['release_patch']
 
 is_website_build = check_for_tag('website')
 
-needs_sphinx = '1.3'
+needs_sphinx = '1.2'
 
 templates_path = ['templates']
 
diff --git a/src/lib/ffi/ffi.h b/src/lib/ffi/ffi.h
index 306fbb0a0..57631bc28 100644
--- a/src/lib/ffi/ffi.h
+++ b/src/lib/ffi/ffi.h
@@ -1476,7 +1476,7 @@ int botan_key_unwrap3394(const uint8_t wrapped_key[], size_t wrapped_key_len,
 typedef struct botan_hotp_struct* botan_hotp_t;
 
 /**
-* Initialize an HOTP instance
+* Initialize a HOTP instance
 */
 BOTAN_PUBLIC_API(2,8)
 int botan_hotp_init(botan_hotp_t* hotp,
@@ -1491,7 +1491,7 @@ BOTAN_PUBLIC_API(2,8)
 int botan_hotp_destroy(botan_hotp_t hotp);
 
 /**
-* Generate an HOTP code for the provided counter
+* Generate a HOTP code for the provided counter
 */
 BOTAN_PUBLIC_API(2,8)
 int botan_hotp_generate(botan_hotp_t hotp,
@@ -1499,7 +1499,7 @@ int botan_hotp_generate(botan_hotp_t hotp,
                         uint64_t hotp_counter);
 
 /**
-* Verify an HOTP code
+* Verify a HOTP code
 */
 BOTAN_PUBLIC_API(2,8)
 int botan_hotp_check(botan_hotp_t hotp,
@@ -1516,7 +1516,7 @@ int botan_hotp_check(botan_hotp_t hotp,
 typedef struct botan_totp_struct* botan_totp_t;
 
 /**
-* Initialize an TOTP instance
+* Initialize a TOTP instance
 */
 BOTAN_PUBLIC_API(2,8)
 int botan_totp_init(botan_totp_t* totp,
@@ -1532,7 +1532,10 @@ BOTAN_PUBLIC_API(2,8)
 int botan_totp_destroy(botan_totp_t totp);
 
 /**
-* Generate an TOTP code for the provided counter
+* Generate a TOTP code for the provided timestamp
+* @param totp the TOTP object
+* @param totp_code the OTP code will be written here
+* @param timestamp the current local timestamp
 */
 BOTAN_PUBLIC_API(2,8)
 int botan_totp_generate(botan_totp_t totp,
@@ -1540,10 +1543,12 @@ int botan_totp_generate(botan_totp_t totp,
                         uint64_t timestamp);
 
 /**
-* Verify an TOTP code
+* Verify a TOTP code
 * @param totp the TOTP object
-* @param clock_drift if non-null and otp code is valid,
-*        set to the drift between the two clocks.
+* @param totp_code the presented OTP
+* @param timestamp the current local timestamp
+* @param acceptable_clock_drift specifies the acceptable amount
+* of clock drift (in terms of time steps) between the two hosts.
 */
 BOTAN_PUBLIC_API(2,8)
 int botan_totp_check(botan_totp_t totp,
-- 
cgit v1.2.3