From cffe97eb6ede164d8169dda4e8922baea3dda0e1 Mon Sep 17 00:00:00 2001
From: Aleksander Machniak <alec@alec.pl>
Date: Sun, 13 Sep 2015 08:50:48 -0400
Subject: [PATCH] CS improvements + some doc
---
plugins/enigma/lib/enigma_driver.php | 18 +++++++++++++++++-
1 files changed, 17 insertions(+), 1 deletions(-)
diff --git a/plugins/enigma/lib/enigma_driver.php b/plugins/enigma/lib/enigma_driver.php
index 10c6d1c..7fa3342 100644
--- a/plugins/enigma/lib/enigma_driver.php
+++ b/plugins/enigma/lib/enigma_driver.php
@@ -33,11 +33,16 @@
/**
* Encryption.
+ *
+ * @param string Message body
+ * @param array List of key-password mapping
+ *
+ * @return mixed Encrypted message or enigma_error on failure
*/
abstract function encrypt($text, $keys);
/**
- * Decryption..
+ * Decryption.
*
* @param string Encrypted message
* @param array List of key-password mapping
@@ -46,6 +51,13 @@
/**
* Signing.
+ *
+ * @param string Message body
+ * @param string Key ID
+ * @param string Key password
+ * @param int Signing mode (enigma_engine::SIGN_*)
+ *
+ * @return mixed True on success or enigma_error on failure
*/
abstract function sign($text, $key, $passwd, $mode = null);
@@ -107,6 +119,10 @@
/**
* Key deletion.
+ *
+ * @param string Key ID
+ *
+ * @return mixed True on success or enigma_error
*/
abstract function delete_key($keyid);
}
--
Gitblit v1.9.1