Add comments/documentation for CNode structure. #4200

pull rebroad wants to merge 1 commits into bitcoin:master from rebroad:CNodeComments changing 1 files +4 −4

rebroad commented at 4:39 AM on May 20, 2014: contributor

Added comments for easier reading.

(I have further pull request coming which adds additional variables for further diagnosis of timings and delays in downloading from other peers).
Add comments/documentation for CNode structure. fd97466c72

in src/net.h:None in fd97466c72

 206 | @@ -207,10 +207,10 @@ class CNode
 207 |      uint64_t nRecvBytes;
 208 |      int nRecvVersion;
 209 |  
 210 | -    int64_t nLastSend;
 211 | -    int64_t nLastRecv;
 212 | -    int64_t nLastSendEmpty;
 213 | -    int64_t nTimeConnected;
 214 | +    int64_t nLastSend;      // Time data last sent to peer.

laanwj commented at 8:11 AM on May 20, 2014:

Please use //!< blabla, as this will show up in the doxygen documentation.

rebroad commented at 11:13 AM on May 21, 2014: contributor

@laanwj Not sure I understand. Is //<! used anywhere else in the code so far? I've not spotted any examples so far.
laanwj commented at 12:44 PM on May 21, 2014: member

Not sure whether it's already used, but it should be used.

See http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html

It's also mentioned in doc/coding-style.md
sipa commented at 9:21 PM on May 21, 2014: member

Something similar is included in #2784, which changes the meanings of some of those variables.
sipa commented at 9:25 PM on May 21, 2014: member

Apologies, these are about message sends, not pings.
BitcoinPullTester commented at 7:29 AM on June 23, 2014: none

Automatic sanity-testing: FAILED MERGE, see http://jenkins.bluematt.me/pull-tester/p4200_fd97466c72709abf4c21008d69a73ced48c99357/ for test log.

This pull does not merge cleanly onto current master This test script verifies pulls every time they are updated. It, however, dies sometimes and fails to test properly. If you are waiting on a test, please check timestamps to verify that the test.log is moving at http://jenkins.bluematt.me/pull-tester/current/ Contact BlueMatt on freenode if something looks broken.
laanwj commented at 8:49 AM on June 25, 2014: member

Needs rebase + nit fix
rebroad closed this on Jun 28, 2014
DrahtBot locked this on Sep 8, 2021

Contributors