Improve documentation for our TO_*_CONN() cast functions.

Preliminary work for #40046.
This commit is contained in:
Nick Mathewson
2020-07-16 09:57:52 -04:00
parent 10d8555e7d
commit b0d7b10088
5 changed files with 41 additions and 10 deletions
+6 -2
View File
@@ -220,8 +220,12 @@ static smartlist_t *outgoing_addrs = NULL;
/**************************************************************/
/** Convert a connection_t* to an listener_connection_t*; assert if the cast
* is invalid. */
/**
* Cast a `connection_t *` to a `listener_connection_t *`.
*
* Exit with an assertion failure if the input is not a
* `listener_connection_t`.
**/
listener_connection_t *
TO_LISTENER_CONN(connection_t *c)
{