Wladimir J. van der Laan bb68abe784 Merge #15718: docs: Improve netaddress comments ...

303372c41a 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

2019-04-11 16:02:54 +02:00

..

bench

…

compat

…

config

…

consensus

…

crypto

…

index

…

interfaces

…

leveldb

…

node

…

obj

…

obj-test

…

policy

…

primitives

…

qt

…

rpc

…

script

…

secp256k1

…

support

…

test

…

univalue

…

util

…

wallet

…

zmq

…

.clang-format

…

addrdb.cpp

…

addrdb.h

…

addrman.cpp

…

addrman.h

…

amount.h

…

arith_uint256.cpp

…

arith_uint256.h

…

attributes.h

…

banman.cpp

…

banman.h

…

base58.cpp

…

base58.h

…

bech32.cpp

…

bech32.h

…

bitcoin-cli-res.rc

…

bitcoin-cli.cpp

…

bitcoin-tx-res.rc

…

bitcoin-tx.cpp

…

bitcoin-wallet-res.rc

…

bitcoin-wallet.cpp

…

bitcoind-res.rc

…

bitcoind.cpp

…

blockencodings.cpp

…

blockencodings.h

…

blockfilter.cpp

…

blockfilter.h

…

bloom.cpp

…

bloom.h

…

chain.cpp

…

chain.h

…

chainparams.cpp

…

chainparams.h

…

chainparamsbase.cpp

…

chainparamsbase.h

…

chainparamsseeds.h

…

checkpoints.cpp

…

checkpoints.h

…

checkqueue.h

…

clientversion.cpp

…

clientversion.h

…

coins.cpp

…

coins.h

…

compat.h

…

compressor.cpp

…

compressor.h

…

core_io.h

…

core_memusage.h

…

core_read.cpp

…

core_write.cpp

…

cuckoocache.h

…

dbwrapper.cpp

…

dbwrapper.h

…

dummywallet.cpp

…

flatfile.cpp

…

flatfile.h

…

fs.cpp

…

fs.h

…

hash.cpp

…

hash.h

…

httprpc.cpp

…

httprpc.h

…

httpserver.cpp

…

httpserver.h

…

indirectmap.h

…

init.cpp

…

init.h

…

key_io.cpp

…

key_io.h

…

key.cpp

…

key.h

…

keystore.cpp

…

keystore.h

…

limitedmap.h

…

logging.cpp

…

logging.h

…

Makefile.am

…

Makefile.bench.include

…

Makefile.leveldb.include

…

Makefile.qt.include

…

Makefile.qttest.include

…

Makefile.test.include

…

memusage.h

…

merkleblock.cpp

…

merkleblock.h

…

miner.cpp

…

miner.h

…

net_processing.cpp

…

net_processing.h

…

net.cpp

…

net.h

…

netaddress.cpp

…

netaddress.h

…

netbase.cpp

…

netbase.h

…

netmessagemaker.h

…

noui.cpp

…

noui.h

…

optional.h

…

outputtype.cpp

…

outputtype.h

…

pow.cpp

…

pow.h

…

prevector.h

…

protocol.cpp

…

protocol.h

…

psbt.cpp

…

psbt.h

…

pubkey.cpp

…

pubkey.h

…

random.cpp

…

random.h

…

rest.cpp

…

reverse_iterator.h

…

reverselock.h

…

scheduler.cpp

…

scheduler.h

…

serialize.h

…

shutdown.cpp

…

shutdown.h

…

span.h

…

streams.h

…

sync.cpp

…

sync.h

…

threadinterrupt.cpp

…

threadinterrupt.h

…

threadsafety.h

…

timedata.cpp

…

timedata.h

…

tinyformat.h

…

torcontrol.cpp

…

torcontrol.h

…

txdb.cpp

…

txdb.h

…

txmempool.cpp

…

txmempool.h

…

ui_interface.cpp

…

ui_interface.h

…

uint256.cpp

…

uint256.h

…

undo.h

…

validation.cpp

…

validation.h

…

validationinterface.cpp

…

validationinterface.h

…

version.h

…

versionbits.cpp

…

versionbits.h

…

versionbitsinfo.cpp

…

versionbitsinfo.h

…

walletinitinterface.h

…

warnings.cpp

…

warnings.h

…