From 70971be96bce4ac7efad7160ac904161a45f5b9b Mon Sep 17 00:00:00 2001
From: Oran Juice <oranjuices@hotmail.com>
Date: Sun, 19 Oct 2014 01:08:21 +0530
Subject: Doxygen comments

---
 src/wallet/wallet2.cpp | 33 +++++++++++++++++++--------------
 src/wallet/wallet2.h   | 28 +++++++++++++++++++++-------
 2 files changed, 40 insertions(+), 21 deletions(-)

diff --git a/src/wallet/wallet2.cpp b/src/wallet/wallet2.cpp
index b4d8068fa..aece1e9d6 100644
--- a/src/wallet/wallet2.cpp
+++ b/src/wallet/wallet2.cpp
@@ -447,10 +447,10 @@ bool wallet2::clear()
 }
 
 /*!
- * 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.
+ * \brief 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)
 {
@@ -502,9 +502,9 @@ namespace
 }
 
 /*!
- * Load wallet information from wallet file.
- * @param keys_file_name Name of wallet file
- * @param password       Password of wallet file
+ * \brief 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)
 {
@@ -544,13 +544,13 @@ void wallet2::load_keys(const std::string& keys_file_name, const std::string& pa
 }
 
 /*!
- * 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
+ * \brief  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)
@@ -580,6 +580,11 @@ crypto::secret_key wallet2::generate(const std::string& wallet_, const std::stri
   return retval;
 }
 
+/*!
+ * \brief Rewrites to the wallet file for wallet upgrade (doesn't generate key, assumes it's already there)
+ * \param wallet_name Name of wallet file (should exist)
+ * \param password    Password for wallet file
+ */
 void wallet2::rewrite(const std::string& wallet_name, const std::string& password)
 {
   prepare_file_names(wallet_name);
diff --git a/src/wallet/wallet2.h b/src/wallet/wallet2.h
index 90b0ec331..d7693e10d 100644
--- a/src/wallet/wallet2.h
+++ b/src/wallet/wallet2.h
@@ -133,9 +133,23 @@ namespace tools
       END_SERIALIZE()
     };
 
+    /*!
+     * \brief 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 generate(const std::string& wallet, const std::string& password,
       const crypto::secret_key& recovery_param = crypto::secret_key(), bool recover = false,
       bool two_random = false);
+    /*!
+     * \brief Rewrites to the wallet file for wallet upgrade (doesn't generate key, assumes it's already there)
+     * \param wallet_name Name of wallet file (should exist)
+     * \param password    Password for wallet file
+     */
     void rewrite(const std::string& wallet_name, const std::string& password);
     void load(const std::string& wallet, const std::string& password);
     void store();
@@ -211,16 +225,16 @@ 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.
+     * \brief  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
+     * \brief 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);
-- 
cgit v1.2.3