aboutsummaryrefslogtreecommitdiff
path: root/src/wallet/wallet2.cpp
diff options
context:
space:
mode:
authorOran Juice <oranjuices@hotmail.com>2014-10-19 01:08:21 +0530
committerOran Juice <oranjuices@hotmail.com>2014-10-19 01:08:21 +0530
commit70971be96bce4ac7efad7160ac904161a45f5b9b (patch)
tree24e47a5708bad434670301d46eb2bf75c33ad5ad /src/wallet/wallet2.cpp
parentRewrites to old wallet file correctly (diff)
downloadmonero-70971be96bce4ac7efad7160ac904161a45f5b9b.tar.xz
Doxygen comments
Diffstat (limited to 'src/wallet/wallet2.cpp')
-rw-r--r--src/wallet/wallet2.cpp33
1 files changed, 19 insertions, 14 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);