Merge bitcoin/bitcoin#27097: descriptors: fix docstring (param [in] vs [out])

588fad868d descriptors: fix docstring (param [in] vs [out]) (SomberNight)

Pull request description:

  As in title, these docstrings look incorrect.

ACKs for top commit:
  john-moffett:
    ACK 588fad868d

Tree-SHA512: 1ab343a1b1fc57a7d6bd8363b84db9d96e8ea11a4cec85bcf79885c9df53da889fe2fb10b1fa92d824ddf0dee800c07353f46f1fea9887d2ad518bed0afebe3d
This commit is contained in:
fanquake 2023-02-14 16:53:16 +00:00
commit fb2f093479
No known key found for this signature in database
GPG key ID: 2EEB9F5CC09526C1

View file

@ -35,7 +35,7 @@ public:
/** Retrieve a cached parent xpub /** Retrieve a cached parent xpub
* *
* @param[in] key_exp_pos Position of the key expression within the descriptor * @param[in] key_exp_pos Position of the key expression within the descriptor
* @param[in] xpub The CExtPubKey to get from cache * @param[out] xpub The CExtPubKey to get from cache
*/ */
bool GetCachedParentExtPubKey(uint32_t key_exp_pos, CExtPubKey& xpub) const; bool GetCachedParentExtPubKey(uint32_t key_exp_pos, CExtPubKey& xpub) const;
/** Cache an xpub derived at an index /** Cache an xpub derived at an index
@ -49,7 +49,7 @@ public:
* *
* @param[in] key_exp_pos Position of the key expression within the descriptor * @param[in] key_exp_pos Position of the key expression within the descriptor
* @param[in] der_index Derivation index of the xpub * @param[in] der_index Derivation index of the xpub
* @param[in] xpub The CExtPubKey to get from cache * @param[out] xpub The CExtPubKey to get from cache
*/ */
bool GetCachedDerivedExtPubKey(uint32_t key_exp_pos, uint32_t der_index, CExtPubKey& xpub) const; bool GetCachedDerivedExtPubKey(uint32_t key_exp_pos, uint32_t der_index, CExtPubKey& xpub) const;
/** Cache a last hardened xpub /** Cache a last hardened xpub
@ -61,7 +61,7 @@ public:
/** Retrieve a cached last hardened xpub /** Retrieve a cached last hardened xpub
* *
* @param[in] key_exp_pos Position of the key expression within the descriptor * @param[in] key_exp_pos Position of the key expression within the descriptor
* @param[in] xpub The CExtPubKey to get from cache * @param[out] xpub The CExtPubKey to get from cache
*/ */
bool GetCachedLastHardenedExtPubKey(uint32_t key_exp_pos, CExtPubKey& xpub) const; bool GetCachedLastHardenedExtPubKey(uint32_t key_exp_pos, CExtPubKey& xpub) const;