From 14115d96d57b8d469151f0ed60aa6fe5188d8bba Mon Sep 17 00:00:00 2001
From: Marek Kotewicz <marek.kotewicz@gmail.com>
Date: Wed, 25 Mar 2015 14:19:09 +0100
Subject: [PATCH] brief docs for libtestutils classes

---
 libtestutils/BlockChainLoader.h     | 3 ++-
 libtestutils/FixedClient.h          | 4 ++++
 libtestutils/FixedWebThreeServer.h  | 6 ++++++
 libtestutils/ShortLivingDirectory.h | 5 +++++
 libtestutils/StateLoader.h          | 3 +++
 5 files changed, 20 insertions(+), 1 deletion(-)

diff --git a/libtestutils/BlockChainLoader.h b/libtestutils/BlockChainLoader.h
index a3528045c..ed110ff6f 100644
--- a/libtestutils/BlockChainLoader.h
+++ b/libtestutils/BlockChainLoader.h
@@ -32,7 +32,8 @@ namespace test
 {
 
 /**
- * @brief - loads the blockchain from json, creates temporary directory to store it, removes this temporary directory on dealloc
+ * @brief Should be used to load test blockchain from json file
+ * Loads the blockchain from json, creates temporary directory to store it, removes the directory on dealloc
  */
 class BlockChainLoader
 {
diff --git a/libtestutils/FixedClient.h b/libtestutils/FixedClient.h
index ce628c651..f0a7c54f6 100644
--- a/libtestutils/FixedClient.h
+++ b/libtestutils/FixedClient.h
@@ -30,6 +30,10 @@ namespace dev
 namespace test
 {
 
+/**
+ * @brief mvp implementation of ClientBase
+ * Doesn't support mining interface
+ */
 class FixedClient: public dev::eth::ClientBase
 {
 public:
diff --git a/libtestutils/FixedWebThreeServer.h b/libtestutils/FixedWebThreeServer.h
index 53db2f2b2..33ccbf71e 100644
--- a/libtestutils/FixedWebThreeServer.h
+++ b/libtestutils/FixedWebThreeServer.h
@@ -24,6 +24,12 @@
 #include <libdevcore/Exceptions.h>
 #include <libweb3jsonrpc/WebThreeStubServerBase.h>
 
+/**
+ * @brief dummy JSON-RPC api implementation
+ * Should be used for test purposes only
+ * Supports eth && db interfaces
+ * Doesn't support shh && net interfaces
+ */
 class FixedWebThreeServer: public dev::WebThreeStubServerBase, public dev::WebThreeStubDatabaseFace
 {
 public:
diff --git a/libtestutils/ShortLivingDirectory.h b/libtestutils/ShortLivingDirectory.h
index 434120e04..bab6a1c20 100644
--- a/libtestutils/ShortLivingDirectory.h
+++ b/libtestutils/ShortLivingDirectory.h
@@ -29,6 +29,11 @@ namespace dev
 namespace test
 {
 
+/**
+ * @brief temporary directory implementation
+ * It creates temporary directory in the given path. On dealloc it removes the directory
+ * @throws if the given path already exists, throws an exception
+ */
 class ShortLivingDirectory
 {
 public:
diff --git a/libtestutils/StateLoader.h b/libtestutils/StateLoader.h
index 10d7251cc..e8f955440 100644
--- a/libtestutils/StateLoader.h
+++ b/libtestutils/StateLoader.h
@@ -29,6 +29,9 @@ namespace dev
 namespace test
 {
 
+/**
+ * @brief Friend of State, loads State from given JSON object
+ */
 class StateLoader
 {
 public: