HomePhabricator

Merge #15718: docs: Improve netaddress comments

Description

Merge #15718: docs: Improve netaddress comments

Summary:
303372c41a8d5c58a46cf9ed595e30e67bd0bc99 docs: Improve netaddress comments (Carl Dong)

Pull request description:

Improves comments for `netaddress`, making them available to Doxygen.

I think this is worthwhile because a lot of the code require some context (e.g., A lot of the things that we do to fit hostnames and tor addresses into `CNetAddr` is non-obvious, and documenting it is beneficial).

ACKs for commit 303372:

Tree-SHA512: 2a35784a01ed8ec5fdbe111a540192d31bde16afa96e4be97b0385daf290fc7469a66d7cb8905a70b920fad6a0e7400ca4e5da082d6e4af1d1aaccc0e8297720

Backport of Core PR15718

Test Plan:

ninja

Reviewers: O1 Bitcoin ABC, #bitcoin_abc, jasonbcox

Reviewed By: O1 Bitcoin ABC, #bitcoin_abc, jasonbcox

Differential Revision: https://reviews.bitcoinabc.org/D6494

Details

Provenance
Wladimir J. van der Laan <laanwj@gmail.com>Authored on Apr 11 2019, 14:02
nakihitoCommitted on Jun 9 2020, 22:57
nakihitoPushed on Jun 9 2020, 22:57
Reviewer
Restricted Owners Package
Differential Revision
D6494: Merge #15718: docs: Improve netaddress comments
Parents
rABCc7721f4a83cd: [backport#16898] test: Remove unused connect_nodes_bi
Branches
Unknown
Tags
Unknown