Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Suppressed compiler warnings when generating wallet API docs #1190

Merged
merged 1 commit into from
Jul 27, 2018
Merged

Suppressed compiler warnings when generating wallet API docs #1190

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 11 additions & 9 deletions libraries/wallet/include/graphene/wallet/wallet.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -409,17 +409,17 @@ class wallet_api
* @param name_or_id The name or ID of an account to retrieve
* @param base Base asset
* @param quote Quote asset
* @param limit The limitation of items each query can fetch, currently 101
* @param start_id Start order id, fetch orders which price are lower than or equal to this order
* @param start_price Fetch orders with price lower than or equal to this price
* @param limit The limitation of items each query can fetch (max: 101)
* @param ostart_id Start order id, fetch orders which price are lower than or equal to this order
* @param ostart_price Fetch orders with price lower than or equal to this price
*
* @return List of orders from @ref name_or_id to the corresponding account
*
* @note
* 1. if @ref name_or_id cannot be tied to an account, empty result will be returned
* 2. @ref start_id and @ref start_price can be empty, if so the api will return the "first page" of orders;
* if start_id is specified and valid, its price will be used to do page query preferentially,
* otherwise the start_price will be used
* 1. if \c name_or_id cannot be tied to an account, empty result will be returned
* 2. \c ostart_id and \c ostart_price can be \c null, if so the api will return the "first page" of orders;
* if \c ostart_id is specified and valid, its price will be used to do page query preferentially,
* otherwise the \c ostart_price will be used
*/
vector<limit_order_object> get_account_limit_orders( const string& name_or_id,
const string &base,
Expand Down Expand Up @@ -921,8 +921,10 @@ class wallet_api
* that it exists in the blockchain. If it exists then it will report the amount received and
* who sent it.
*
* @param opt_from - if not empty and the sender is a unknown public key, then the unknown public key will be given the label opt_from
* @param confirmation_receipt - a base58 encoded stealth confirmation
* @param opt_from if not empty and the sender is a unknown public key,
* then the unknown public key will be given the label \c opt_from
* @param confirmation_receipt a base58 encoded stealth confirmation
* @param opt_memo a self-defined label for this transfer to be saved in local wallet file
*/
blind_receipt receive_blind_transfer( string confirmation_receipt, string opt_from, string opt_memo );

Expand Down