diff options
author | Oran Juice <oranjuices@hotmail.com> | 2014-09-27 18:20:15 +0530 |
---|---|---|
committer | Oran Juice <oranjuices@hotmail.com> | 2014-09-27 18:20:15 +0530 |
commit | f31adbc977939036d51d59e8ddb5cdf2c61ecd97 (patch) | |
tree | d966cedaae9d4f2f31b1f779f3cf6619e16e731f /src/simplewallet/simplewallet.h | |
parent | Informs about old style mnemonics from older wallet and provides a new one. C... (diff) | |
download | monero-f31adbc977939036d51d59e8ddb5cdf2c61ecd97.tar.xz |
Doxygen comments in
Diffstat (limited to 'src/simplewallet/simplewallet.h')
-rw-r--r-- | src/simplewallet/simplewallet.h | 24 |
1 files changed, 20 insertions, 4 deletions
diff --git a/src/simplewallet/simplewallet.h b/src/simplewallet/simplewallet.h index 7a21f1cd2..8567b2343 100644 --- a/src/simplewallet/simplewallet.h +++ b/src/simplewallet/simplewallet.h @@ -28,6 +28,11 @@ // // Parts of this file are originally copyright (c) 2012-2013 The Cryptonote developers +/*! + * \file simplewallet.h + * + * \brief Header file that declares simple_wallet class. + */ #pragma once #include <memory> @@ -41,12 +46,15 @@ #include "password_container.h" #include "crypto/crypto.h" // for definition of crypto::secret_key - +/*! + * \namespace cryptonote + * \brief Holds cryptonote related classes and helpers. + */ namespace cryptonote { - /************************************************************************/ - /* */ - /************************************************************************/ + /*! + * \brief Manages wallet operations. This is the most abstracted wallet class. + */ class simple_wallet : public tools::i_wallet2_callback { public: @@ -92,6 +100,14 @@ namespace cryptonote uint64_t get_daemon_blockchain_height(std::string& err); bool try_connect_to_daemon(); bool ask_wallet_create_if_needed(); + + /*! + * \brief Gets the word seed language from the user. + * + * User is asked to choose from a list of supported languages. + * + * \return The chosen language. + */ std::string get_mnemonic_language(); //----------------- i_wallet2_callback --------------------- |