d0s3t3ch/wownero
1
0
Fork 0
mirror of https://git.wownero.com/wownero/wownero.git synced 2024-08-15 01:03:23 +00:00
Code Issues Projects Releases Wiki Activity

wallet2: Update function parameter documentation

Browse source 
This completes and fixes various parameters docs
This commit is contained in:
Leon Klingele 2018-03-14 16:41:24 +01:00
parent a69c713f8e
commit 80d2f8007c
No known key found for this signature in database
GPG key ID: 83AEC0FEBAA5D483
2 changed files with 41 additions and 31 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
src/wallet/wallet2.cpp
View file

@ -2699,6 +2699,7 @@ bool wallet2::verify_password(const epee::wipeable_string& password) const
* \param keys_file_name Keys file to verify password for * \param keys_file_name Keys file to verify password for
* \param password Password to verify * \param password Password to verify
* \param no_spend_key If set = only verify view keys, otherwise also spend keys * \param no_spend_key If set = only verify view keys, otherwise also spend keys
* \param hwdev The hardware device to use
* \return true if password is correct * \return true if password is correct
* *
* for verification only * for verification only
@ -2752,6 +2753,7 @@ bool wallet2::verify_password(const std::string& keys_file_name, const epee::wip
* \param wallet_ Name of wallet file * \param wallet_ Name of wallet file
* \param password Password of wallet file * \param password Password of wallet file
* \param multisig_data The multisig restore info and keys * \param multisig_data The multisig restore info and keys
* \param create_address_file Whether to create an address file
*/ */
void wallet2::generate(const std::string& wallet_, const epee::wipeable_string& password, void wallet2::generate(const std::string& wallet_, const epee::wipeable_string& password,
const std::string& multisig_data, bool create_address_file) const std::string& multisig_data, bool create_address_file)
@ -2849,6 +2851,7 @@ void wallet2::generate(const std::string& wallet_, const epee::wipeable_string&
* \param recovery_param If it is a restore, the recovery key * \param recovery_param If it is a restore, the recovery key
* \param recover Whether it is a restore * \param recover Whether it is a restore
* \param two_random Whether it is a non-deterministic wallet * \param two_random Whether it is a non-deterministic wallet
* \param create_address_file Whether to create an address file
* \return The secret key of the generated wallet * \return The secret key of the generated wallet
*/ */
crypto::secret_key wallet2::generate(const std::string& wallet_, const epee::wipeable_string& password, crypto::secret_key wallet2::generate(const std::string& wallet_, const epee::wipeable_string& password,
@ -2947,7 +2950,9 @@ crypto::secret_key wallet2::generate(const std::string& wallet_, const epee::wip
* \brief Creates a watch only wallet from a public address and a view secret key. * \brief Creates a watch only wallet from a public address and a view secret key.
* \param wallet_ Name of wallet file * \param wallet_ Name of wallet file
* \param password Password of wallet file * \param password Password of wallet file
* \param account_public_address The account's public address
* \param viewkey view secret key * \param viewkey view secret key
* \param create_address_file Whether to create an address file
*/ */
void wallet2::generate(const std::string& wallet_, const epee::wipeable_string& password, void wallet2::generate(const std::string& wallet_, const epee::wipeable_string& password,
const cryptonote::account_public_address &account_public_address, const cryptonote::account_public_address &account_public_address,
@ -2996,8 +3001,10 @@ void wallet2::generate(const std::string& wallet_, const epee::wipeable_string&
* \brief Creates a wallet from a public address and a spend/view secret key pair. * \brief Creates a wallet from a public address and a spend/view secret key pair.
* \param wallet_ Name of wallet file * \param wallet_ Name of wallet file
* \param password Password of wallet file * \param password Password of wallet file
* \param account_public_address The account's public address
* \param spendkey spend secret key * \param spendkey spend secret key
* \param viewkey view secret key * \param viewkey view secret key
* \param create_address_file Whether to create an address file
*/ */
void wallet2::generate(const std::string& wallet_, const epee::wipeable_string& password, void wallet2::generate(const std::string& wallet_, const epee::wipeable_string& password,
const cryptonote::account_public_address &account_public_address, const cryptonote::account_public_address &account_public_address,
@ -3446,6 +3453,7 @@ void wallet2::rewrite(const std::string& wallet_name, const epee::wipeable_strin
* \brief Writes to a file named based on the normal wallet (doesn't generate key, assumes it's already there) * \brief Writes to a file named based on the normal wallet (doesn't generate key, assumes it's already there)
* \param wallet_name Base name of wallet file * \param wallet_name Base name of wallet file
* \param password Password for wallet file * \param password Password for wallet file
* \param new_keys_filename [OUT] Name of new keys file
*/ */
void wallet2::write_watch_only_wallet(const std::string& wallet_name, const epee::wipeable_string& password, std::string &new_keys_filename) void wallet2::write_watch_only_wallet(const std::string& wallet_name, const epee::wipeable_string& password, std::string &new_keys_filename)
{ {

12
src/wallet/wallet2.h
View file

@ -474,8 +474,9 @@ namespace tools
* \brief Creates a wallet from a public address and a spend/view secret key pair. * \brief Creates a wallet from a public address and a spend/view secret key pair.
* \param wallet_ Name of wallet file * \param wallet_ Name of wallet file
* \param password Password of wallet file * \param password Password of wallet file
* \param viewkey view secret key * \param account_public_address The account's public address
* \param spendkey spend secret key * \param spendkey spend secret key
* \param viewkey view secret key
* \param create_address_file Whether to create an address file * \param create_address_file Whether to create an address file
*/ */
void generate(const std::string& wallet, const epee::wipeable_string& password, void generate(const std::string& wallet, const epee::wipeable_string& password,
@ -485,6 +486,7 @@ namespace tools
* \brief Creates a watch only wallet from a public address and a view secret key. * \brief Creates a watch only wallet from a public address and a view secret key.
* \param wallet_ Name of wallet file * \param wallet_ Name of wallet file
* \param password Password of wallet file * \param password Password of wallet file
* \param account_public_address The account's public address
* \param viewkey view secret key * \param viewkey view secret key
* \param create_address_file Whether to create an address file * \param create_address_file Whether to create an address file
*/ */
@ -556,9 +558,9 @@ namespace tools
void load(const std::string& wallet, const epee::wipeable_string& password); void load(const std::string& wallet, const epee::wipeable_string& password);
void store(); void store();
/*! /*!
* \brief store_to - stores wallet to another file(s), deleting old ones * \brief store_to Stores wallet to another file(s), deleting old ones
* \param path - path to the wallet file (keys and address filenames will be generated based on this filename) * \param path Path to the wallet file (keys and address filenames will be generated based on this filename)
* \param password - password to protect new wallet (TODO: probably better save the password in the wallet object?) * \param password Password to protect new wallet (TODO: probably better save the password in the wallet object?)
*/ */
void store_to(const std::string &path, const epee::wipeable_string &password); void store_to(const std::string &path, const epee::wipeable_string &password);
@ -942,7 +944,7 @@ namespace tools
/*! /*!
* \brief Set the label of the given tag. * \brief Set the label of the given tag.
* \param tag Tag's name (which must be non-empty). * \param tag Tag's name (which must be non-empty).
* \param label Tag's description. * \param description Tag's description.
*/ */
void set_account_tag_description(const std::string& tag, const std::string& description); void set_account_tag_description(const std::string& tag, const std::string& description);