f: document InitSyncTracker

Author: arik-so

lightning/src/ln/peer_handler.rs

@@ -509,9 +509,18 @@ impl fmt::Display for PeerHandleError {
 	}
 }
 
+/// Internal struct for keeping track of the gossip syncing progress with a given peer
 enum InitSyncTracker{
+	/// Only sync ad-hoc gossip as it comes in, do not send historical gossip.
+	/// Upon receipt of a GossipTimestampFilter message, this is the default initial state if the
+	/// contained timestamp is less than 6 hours old.
 	NoSyncRequested,
+	/// Send historical gossip starting at the given channel id, which gets incremented as the
+	/// gossiping progresses.
+	/// Upon receipt of a GossipTimestampFilter message, this is the default initial state if the
+	/// contained timestamp is at least 6 hours old, and the initial channel id is set to 0.
 	ChannelsSyncing(u64),
+	/// Upon completion of channel syncing, the node gossip is synced.
 	NodesSyncing(NodeId),
 }