Skip to content

Commit e58598e

Browse files
committed
[addrman] Add doxygen comment to AddrMan::Add()
Does not document the return value since we're going to fix the semantics in a future commit.
1 parent ab25ef8 commit e58598e

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

src/addrman.h

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,14 @@ class AddrMan
6969
//! Return the number of (unique) addresses in all tables.
7070
size_t size() const;
7171

72-
//! Add addresses to addrman's new table.
72+
/**
73+
* Attempt to add one or more addresses to addrman's new table.
74+
*
75+
* @param[in] vAddr Address records to attempt to add.
76+
* @param[in] source The address of the node that sent us these addr records.
77+
* @param[in] nTimePenalty A "time penalty" to apply to the address record's nTime. If a peer
78+
* sends us an address record with nTime=n, then we'll add it to our
79+
* addrman with nTime=(n - nTimePenalty). */
7380
bool Add(const std::vector<CAddress>& vAddr, const CNetAddr& source, int64_t nTimePenalty = 0);
7481

7582
//! Mark an entry as accessible, possibly moving it from "new" to "tried".

0 commit comments

Comments
 (0)