]> git.ipfire.org Git - thirdparty/tor.git/commitdiff
connection: Improve function comments
authorteor <teor@torproject.org>
Wed, 29 Jan 2020 08:22:21 +0000 (18:22 +1000)
committerteor <teor@torproject.org>
Wed, 29 Jan 2020 08:22:21 +0000 (18:22 +1000)
Improve the function comments on connection_finished_connecting(),
to describe what the function actually does.

Part of 33091.

src/core/mainloop/connection.c

index 223428a8f67b5b69df72686dc4585136bc5e6b23..4a2dc21f1caea03386ea114194126e3b2fb72429 100644 (file)
@@ -4970,10 +4970,10 @@ connection_finished_flushing(connection_t *conn)
   }
 }
 
-/** Called when our attempt to connect() to another server has just
- * succeeded.
+/** Called when our attempt to connect() to a server has just succeeded.
  *
- * This function just passes conn to the connection-specific
+ * This function checks if the interface address has changed (clients only),
+ * and then passes conn to the connection-specific
  * connection_*_finished_connecting() function.
  */
 static int