doc: clarify new_only param for Select function

Co-authored-by: Martin Zumsande <mzumsande@gmail.com>
This commit is contained in:
Amiti Uttarwar 2023-03-10 18:25:59 -08:00
parent b0010c83a1
commit 17e705428d

View file

@ -146,7 +146,9 @@ public:
/**
* Choose an address to connect to.
*
* @param[in] new_only Whether to only select addresses from the new table.
* @param[in] new_only Whether to only select addresses from the new table. Passing `true` returns
* an address from the new table or an empty pair. Passing `false` will return an
* address from either the new or tried table (it does not guarantee a tried entry).
* @param[in] network Select only addresses of this network (nullopt = all)
* @return CAddress The record for the selected peer.
* seconds The last time we attempted to connect to that peer.