zecfoundation
/
zcashd
mirror of https://github.com/ZcashFoundation/zcashd.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Remove incorrect FFI method documentation. 

Co-authored-by: str4d <jack@electriccoin.co>
This commit is contained in:
Kris Nuttycombe 2021-11-29 13:08:30 -07:00 committed by GitHub
parent e7c507cfb3
commit bde245d8bc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/rust/include/rust/orchard/keys.h
View File

@ -70,9 +70,7 @@ OrchardIncomingViewingKeyPtr* orchard_incoming_viewing_key_parse(
read_callback_t read_cb); read_callback_t read_cb);
/** /**
* Serializes an Orchard incoming viewing key to the given stream * Serializes an Orchard incoming viewing key to the given stream.
*
* If `incoming_viewing_key == nullptr`, this serializes `nActionsOrchard = 0`.
*/ */
bool orchard_incoming_viewing_key_serialize( bool orchard_incoming_viewing_key_serialize(
const OrchardIncomingViewingKeyPtr* incoming_viewing_key, const OrchardIncomingViewingKeyPtr* incoming_viewing_key,
@ -124,9 +122,7 @@ OrchardFullViewingKeyPtr* orchard_full_viewing_key_parse(
read_callback_t read_cb); read_callback_t read_cb);
/** /**
* Serializes an Orchard full viewing key to the given stream * Serializes an Orchard full viewing key to the given stream.
*
* If `full_viewing_key == nullptr`, this serializes `nActionsOrchard = 0`.
*/ */
bool orchard_full_viewing_key_serialize( bool orchard_full_viewing_key_serialize(
const OrchardFullViewingKeyPtr* full_viewing_key, const OrchardFullViewingKeyPtr* full_viewing_key,
@ -187,9 +183,7 @@ OrchardSpendingKeyPtr* orchard_spending_key_parse(
read_callback_t read_cb); read_callback_t read_cb);
/** /**
* Serializes an Orchard spending key to the given stream * Serializes an Orchard spending key to the given stream.
*
* If `spending_key == nullptr`, this will return `false`
*/ */
bool orchard_spending_key_serialize( bool orchard_spending_key_serialize(
const OrchardSpendingKeyPtr* spending_key, const OrchardSpendingKeyPtr* spending_key,