Skip to content

Commit e711200

Browse files
committed
doc: update ConnectionType Doxygen documentation
1 parent 9de6a3c commit e711200

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

src/net.h

+6-5
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,8 @@ struct CSerializedNetMsg
111111
* connection. Aside from INBOUND, all types are initiated by us.
112112
*
113113
* If adding or removing types, please update CONNECTION_TYPE_DOC in
114-
* src/rpc/net.cpp. */
114+
* src/rpc/net.cpp and src/qt/rpcconsole.cpp, as well as the descriptions in
115+
* src/qt/guiutil.cpp and src/bitcoin-cli.cpp::NetinfoRequestHandler. */
115116
enum class ConnectionType {
116117
/**
117118
* Inbound connections are those initiated by a peer. This is the only
@@ -122,16 +123,16 @@ enum class ConnectionType {
122123

123124
/**
124125
* These are the default connections that we use to connect with the
125-
* network. There is no restriction on what is relayed- by default we relay
126+
* network. There is no restriction on what is relayed; by default we relay
126127
* blocks, addresses & transactions. We automatically attempt to open
127128
* MAX_OUTBOUND_FULL_RELAY_CONNECTIONS using addresses from our AddrMan.
128129
*/
129130
OUTBOUND_FULL_RELAY,
130131

131132

132133
/**
133-
* We open manual connections to addresses that users explicitly inputted
134-
* via the addnode RPC, or the -connect command line argument. Even if a
134+
* We open manual connections to addresses that users explicitly requested
135+
* via the addnode RPC or the -addnode/-connect configuration options. Even if a
135136
* manual connection is misbehaving, we do not automatically disconnect or
136137
* add it to our discouragement filter.
137138
*/
@@ -150,7 +151,7 @@ enum class ConnectionType {
150151
* although in our codebase feeler connections encompass test-before-evict as well.
151152
* We make these connections approximately every FEELER_INTERVAL:
152153
* first we resolve previously found collisions if they exist (test-before-evict),
153-
* otherwise connect to a node from the new table.
154+
* otherwise we connect to a node from the new table.
154155
*/
155156
FEELER,
156157

0 commit comments

Comments
 (0)