[trivial] Add doxygen-compatible comments to CAffectedKeysVisitor #13843

pull PierreRochard wants to merge 1 commits into bitcoin:master from PierreRochard:aff-keys-comments changing 1 files +11 −0

PierreRochard commented at 10:40 PM on August 1, 2018: contributor

No description provided.
PierreRochard force-pushed on Aug 1, 2018
fanquake added the label Docs on Aug 1, 2018
in src/wallet/wallet.cpp:114 in 94ba202c39 outdated
```
 109 |      std::vector<CKeyID> &vKeys;
 110 |  
 111 |  public:
 112 | +    /**
 113 | +     * @param keystoreIn The CKeyStore that is queried for the presence of a pubkey.
 114 | +     * @param vKeysIn A vector to which a script's pubkey identifiers are appended if they are in the keystore.
```
Empact commented at 11:00 PM on August 1, 2018:

nit: could declare these [in]

PierreRochard commented at 11:21 PM on August 1, 2018:

I'm not familiar with that, link or elaboration please :)

Empact commented at 2:00 AM on August 2, 2018:

https://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmdparam

PierreRochard commented at 7:31 PM on August 3, 2018:

Thanks, fixed

in src/wallet/wallet.cpp:121 in 94ba202c39 outdated

 116 |      CAffectedKeysVisitor(const CKeyStore &keystoreIn, std::vector<CKeyID> &vKeysIn) : keystore(keystoreIn), vKeys(vKeysIn) {}
 117 |  
 118 | +    /** 
 119 | +     * Apply the visitor to each destination in a script, recursively to the redeemscript
 120 | +     * in the case of p2sh destinations.
 121 | +     * @return void

Empact commented at 11:00 PM on August 1, 2018:

nit: seems extraneous

PierreRochard commented at 11:21 PM on August 1, 2018:

Agree, fixed

in src/wallet/wallet.cpp:123 in 94ba202c39 outdated

 118 | +    /** 
 119 | +     * Apply the visitor to each destination in a script, recursively to the redeemscript
 120 | +     * in the case of p2sh destinations.
 121 | +     * @return void
 122 | +     * @param script The CScript from which destinations are extracted.
 123 | +     * @post Any CKeyIDs that script and keystore have in common are appended to vKeys.

Empact commented at 11:02 PM on August 1, 2018:

nit: maybe make it explicit that they’re added to the visitor’s vKeys

PierreRochard commented at 11:21 PM on August 1, 2018:

Agree, fixed

Empact commented at 11:03 PM on August 1, 2018: member

ACK would improve pages like this one: https://dev.visucore.com/bitcoin/doxygen/class_c_affected_keys_visitor.html

in src/wallet/wallet.cpp:118 in 94ba202c39 outdated

 113 | +     * @param keystoreIn The CKeyStore that is queried for the presence of a pubkey.
 114 | +     * @param vKeysIn A vector to which a script's pubkey identifiers are appended if they are in the keystore.
 115 | +     */
 116 |      CAffectedKeysVisitor(const CKeyStore &keystoreIn, std::vector<CKeyID> &vKeysIn) : keystore(keystoreIn), vKeys(vKeysIn) {}
 117 |  
 118 | +    /**

sipa commented at 11:08 PM on August 1, 2018:

Linter complains about trailing whitespace here.

PierreRochard commented at 11:32 PM on August 1, 2018:

Thanks, fixed

PierreRochard force-pushed on Aug 1, 2018
[trivial] add doxygen-compatible comments to CAffectedKeysVisitor 3339d84535
PierreRochard force-pushed on Aug 3, 2018
Empact commented at 8:00 PM on August 3, 2018: member

ACK 3339d84
fanquake commented at 4:53 AM on August 4, 2018: member

utACK 3339d84
laanwj commented at 2:49 PM on August 7, 2018: member

thanks for adding developer documentation!

utACK 3339d845354c9c357ec90505192748d9d639e72e
laanwj merged this on Aug 7, 2018
laanwj closed this on Aug 7, 2018
laanwj referenced this in commit e8f387f997 on Aug 7, 2018
PierreRochard deleted the branch on Aug 7, 2018
PastaPastaPasta referenced this in commit ff228ab92e on Jun 27, 2021
PastaPastaPasta referenced this in commit dbe29747d2 on Jun 28, 2021
PastaPastaPasta referenced this in commit c1fa3b036c on Jun 29, 2021
PastaPastaPasta referenced this in commit acd3915965 on Jun 29, 2021
PastaPastaPasta referenced this in commit 417a467d77 on Jun 29, 2021
PastaPastaPasta referenced this in commit 15c2235251 on Jun 29, 2021
PastaPastaPasta referenced this in commit 1ecce00405 on Jun 29, 2021
DrahtBot locked this on Sep 8, 2021

Contributors

Labels