Docs complete

paixaop · Apr 17, 2016 · 7437e8c · 7437e8c
1 parent 31ccf89
commit 7437e8c
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 8 deletions.
diff --git a/out.md b/out.md
@@ -44,7 +44,7 @@ Replace `ALGORITHM` with one of the supported algorithms (`aes256gcm`,
 * `crypto_aead_ALGORITHM_NPUBBYTES` <span class='dash'>&mdash;</span> lenght of public nonce
 * `crypto_aead_ALGORITHM_NSECBYTES` <span class='dash'>&mdash;</span> length of secret nonce. Not used
 
-### Crypto AEAD AES-GCM 256
+### Crypto AEAD AES-GCM 256 API
 
 
 The current implementation of this construction is hardware-accelerated and
@@ -57,10 +57,6 @@ There are no plans to support non hardware-accelerated implementations of
 [AES-GCM](https://en.wikipedia.org/wiki/Galois/Counter_Mode).
 If portability is a concern, use ChaCha20-Poly1305 instead.
 
-### Low Level API
-
-
-
 ### Precompute API
 
 
@@ -422,6 +418,10 @@ Encrypt Message in Detached Mode
 
 **See**: [crypto_aead_aes256gcm_encrypt](#crypto_aead_aes256gcm_encrypt)
 
+### Crypto AEAD ChaCha20-Poly1305 API
+
+
+
 ### crypto_aead_chacha20poly1305_encrypt
 
 Encrypt Message in Detached Mode using ChaCha20-Poly1305
@@ -446,6 +446,10 @@ Dencrypt Message in Detached Mode using ChaCha20-Poly1305
 
 See [crypto_aead_aes256gcm_decrypt_detached](#crypto_aead_aes256gcm_decrypt_detached)
 
+### Crypto AEAD ChaCha20-Poly1305-IETF API
+
+
+
 ### crypto_aead_chacha20poly1305_ietf_encrypt
 
 Encrypt Message in Combined Mode using ChaCha20-Poly1305-IETF

diff --git a/src/crypto_aead.cc b/src/crypto_aead.cc
@@ -54,7 +54,7 @@
  */
 
 /**
- * Crypto AEAD AES-GCM 256:
+ * Crypto AEAD AES-GCM 256 API:
  *
  * The current implementation of this construction is hardware-accelerated and
  * requires the Intel SSSE3 extensions, as well as the aesni and pclmul
@@ -67,8 +67,6 @@
  * If portability is a concern, use ChaCha20-Poly1305 instead.
  */
 
-/** Low Level API: */
-
 /**
  * Precompute API:
  *
@@ -517,6 +515,7 @@ CRYPTO_AEAD_DEF(aes256gcm)
   */
 CRYPTO_AEAD_DETACHED_DEF(aes256gcm)
 
+/** Crypto AEAD ChaCha20-Poly1305 API: */
 /**
  * crypto_aead_chacha20poly1305_encrypt:
  * Encrypt Message in Detached Mode using ChaCha20-Poly1305
@@ -547,6 +546,7 @@ CRYPTO_AEAD_DEF(chacha20poly1305)
  */
 CRYPTO_AEAD_DETACHED_DEF(chacha20poly1305)
 
+/** Crypto AEAD ChaCha20-Poly1305-IETF API: */
 /**
  * crypto_aead_chacha20poly1305_ietf_encrypt:
  * Encrypt Message in Combined Mode using ChaCha20-Poly1305-IETF