From 8f45c2409ca2f28f716f01d09047c6bb6f90d9b9 Mon Sep 17 00:00:00 2001
From: andreaP <andrea.peruffo@unicredit.eu>
Date: Tue, 23 Dec 2014 15:38:51 +0100
Subject: proposal of documentation

---
 lib/crypto/doc/src/crypto.xml | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)

(limited to 'lib/crypto')

diff --git a/lib/crypto/doc/src/crypto.xml b/lib/crypto/doc/src/crypto.xml
index 271130a9e6..77cff252ef 100644
--- a/lib/crypto/doc/src/crypto.xml
+++ b/lib/crypto/doc/src/crypto.xml
@@ -169,7 +169,38 @@
  </section>
 
   <funcs>
+      <func>
+      <name>block_encrypt(Type, Key, PlainText) -> CipherText</name>
+      <fsummary>Encrypt <c>PlainText</c>according to <c>Type</c> block cipher</fsummary>
+      <type>
+  <v>Type = des_ecb | blowfish_ecb | aes_ecb </v>
+  <v>Key = block_key() </v>
+        <v>PlainText = iodata() </v>
+      </type>
+      <desc>
+        <p>Encrypt <c>PlainText</c>according to <c>Type</c> block cipher.
+  <p>May throw exception <c>notsup</c> in case the chosen <c>Type</c>
+  is not supported by the underlying OpenSSL implementation.</p>
+      </desc>
+    </func>
+
     <func>
+      <name>block_decrypt(Type, Key, CipherText) -> PlainText</name>
+      <fsummary>Decrypt <c>CipherText</c>according to <c>Type</c> block cipher</fsummary>
+      <type>
+  <v>Type = des_ecb | blowfish_ecb | aes_ecb </v>
+  <v>Key = block_key() </v>
+        <v>PlainText = iodata() </v>
+      </type>
+      <desc>
+        <p>Decrypt <c>CipherText</c>according to <c>Type</c> block cipher.
+  <p>May throw exception <c>notsup</c> in case the chosen <c>Type</c>
+  is not supported by the underlying OpenSSL implementation.</p>
+      </desc>
+    </func>
+
+  <funcs>
+      <func>
       <name>block_encrypt(Type, Key, Ivec, PlainText) -> CipherText</name>
       <name>block_encrypt(AeadType, Key, Ivec, {AAD, PlainText}) -> {CipherText, CipherTag}</name>
       <fsummary>Encrypt <c>PlainText</c> according to <c>Type</c> block cipher</fsummary>
-- 
cgit v1.2.3