doc: Add developer documentation to isminetype #17217

issue MarcoFalke opened this issue on October 22, 2019

MarcoFalke commented at 3:13 PM on October 22, 2019: member

Stuff like ISMINE_USED is not self-explanatory and completely undocumented: https://dev.visucore.com/bitcoin/doxygen/ismine_8h.html#a050f9a1a807967a24bcbeebfc5952533
MarcoFalke added the label Docs on Oct 22, 2019
MarcoFalke added the label good first issue on Oct 22, 2019
HAOYUatHZ commented at 12:13 AM on October 23, 2019: contributor

let me open a PR soon to address these in ismine.h and ismine.cpp

I guess explaining the enumerators and the function logic
will be sufficient?
HAOYUatHZ commented at 1:05 PM on October 23, 2019: contributor
Stuff like ISMINE_USED is not self-explanatory and completely undocumented: https://dev.visucore.com/bitcoin/doxygen/ismine_8h.html#a050f9a1a807967a24bcbeebfc5952533

Just to double check:
- ISMINE_USED: an output pays to my reused address
- ISMINE_NO: the output doesn't pay to me
- ISMINE_WATCH_ONLY: my pubkey is a member of the multi-sig address an output paying to
- ISMINE_SPENDABLE: an output pays to me
MarcoFalke commented at 2:36 PM on October 24, 2019: member

ISMINE_WATCH_ONLY: my pubkey is a member of the multi-sig address an output paying to

No it can be any scriptPubKey that has been imported
HAOYUatHZ commented at 6:07 AM on October 30, 2019: contributor

ISMINE_WATCH_ONLY: my pubkey is a member of the multi-sig address an output paying to

No it can be any scriptPubKey that has been imported

sorry I haven't managed to add explanations directly shown in doxygen-ed html

was trying to add the explanations in the table

I guess i could just put it in the source ".h" / ".c" files? people can navigate to page like "ismine_8h_source.html" when browsing.
laanwj commented at 3:32 PM on February 5, 2020: member

Closing this, as it seems controversial, an attempt was done in #17350 but it's not clear it will actually be merged. But discussion is over there.
laanwj closed this on Feb 5, 2020
fanquake removed the label good first issue on Feb 19, 2020
sidhujag referenced this in commit 67f2bfb0f0 on Jan 26, 2021
MarcoFalke locked this on Feb 15, 2022
PastaPastaPasta referenced this in commit aac5f63e6d on Apr 3, 2022
PastaPastaPasta referenced this in commit 36e5e6c85c on Apr 4, 2022

Contributors

Labels

Linked (view graph)

#17350 doc: Add developer documentation to isminetype