From 1f833dcf7760094358c3037b4af6a263c3ef236d Mon Sep 17 00:00:00 2001
From: Oran Juice <oranjuices@hotmail.com>
Date: Sat, 18 Oct 2014 23:11:05 +0530
Subject: [PATCH] Doxygen comments in

---
 src/wallet/wallet2.cpp | 27 ++++++++++++++++++++++++---
 src/wallet/wallet2.h   | 15 +++++++++++++--
 2 files changed, 37 insertions(+), 5 deletions(-)

diff --git a/src/wallet/wallet2.cpp b/src/wallet/wallet2.cpp
index 1ac3805a7..013dcbcb1 100644
--- a/src/wallet/wallet2.cpp
+++ b/src/wallet/wallet2.cpp
@@ -104,6 +104,7 @@ bool wallet2::get_seed(std::string& electrum_words)
 }
 /*!
  * \brief Sets the seed language
+ * \param language  Seed language to set to
  */
 void wallet2::set_seed_language(const std::string &language)
 {
@@ -444,7 +445,13 @@ bool wallet2::clear()
   m_local_bc_height = 1;
   return true;
 }
-//----------------------------------------------------------------------------------------------------
+
+/*!
+ * Stores wallet information to wallet file.
+ * @param  keys_file_name Name of wallet file
+ * @param  password       Password of wallet file
+ * @return                Whether it was successful.
+ */
 bool wallet2::store_keys(const std::string& keys_file_name, const std::string& password)
 {
   std::string account_data;
@@ -493,7 +500,12 @@ namespace
     return r && expected_pub == pub;
   }
 }
-//----------------------------------------------------------------------------------------------------
+
+/*!
+ * Load wallet information from wallet file.
+ * @param keys_file_name Name of wallet file
+ * @param password       Password of wallet file
+ */
 void wallet2::load_keys(const std::string& keys_file_name, const std::string& password)
 {
   wallet2::keys_file_data keys_file_data;
@@ -530,7 +542,16 @@ void wallet2::load_keys(const std::string& keys_file_name, const std::string& pa
   r = r && verify_keys(keys.m_spend_secret_key, keys.m_account_address.m_spend_public_key);
   THROW_WALLET_EXCEPTION_IF(!r, error::invalid_password);
 }
-//----------------------------------------------------------------------------------------------------
+
+/*!
+ * Generates a wallet or restores one.
+ * @param  wallet_        Name of wallet file
+ * @param  password       Password of wallet file
+ * @param  recovery_param If it is a restore, the recovery key
+ * @param  recover        Whether it is a restore
+ * @param  two_random     Whether it is a non-deterministic wallet
+ * @return                The secret key of the generated wallet
+ */
 crypto::secret_key wallet2::generate(const std::string& wallet_, const std::string& password, const crypto::secret_key& recovery_param, bool recover, bool two_random)
 {
   clear();
diff --git a/src/wallet/wallet2.h b/src/wallet/wallet2.h
index 10b4d6f3f..c3dfa4df6 100644
--- a/src/wallet/wallet2.h
+++ b/src/wallet/wallet2.h
@@ -207,7 +207,18 @@ namespace tools
 
     static std::string address_from_txt_record(const std::string& s);
   private:
+    /*!
+     * Stores wallet information to wallet file.
+     * @param  keys_file_name Name of wallet file
+     * @param  password       Password of wallet file
+     * @return                Whether it was successful.
+     */
     bool store_keys(const std::string& keys_file_name, const std::string& password);
+    /*!
+     * Load wallet information from wallet file.
+     * @param keys_file_name Name of wallet file
+     * @param password       Password of wallet file
+     */
     void load_keys(const std::string& keys_file_name, const std::string& password);
     void process_new_transaction(const cryptonote::transaction& tx, uint64_t height);
     void process_new_blockchain_entry(const cryptonote::block& b, cryptonote::block_complete_entry& bche, crypto::hash& bl_id, uint64_t height);
@@ -243,8 +254,8 @@ namespace tools
 
     i_wallet2_callback* m_callback;
     bool m_testnet;
-    std::string seed_language;
-    bool is_old_file_format;
+    std::string seed_language; /*!< Language of the mnemonics (seed). */
+    bool is_old_file_format; /*!< Whether the wallet file is of an old file format */
   };
 }
 BOOST_CLASS_VERSION(tools::wallet2, 7)