diff options
| author | Nick Mathewson <nickm@torproject.org> | 2020-07-16 09:57:52 -0400 |
|---|---|---|
| committer | Nick Mathewson <nickm@torproject.org> | 2020-07-16 09:57:52 -0400 |
| commit | b0d7b100886ef14a785f6ca1de968df9a884d0a7 (patch) | |
| tree | 931f94cbc9dd273a6df31ef3e93623babfc1ec2b /src/feature/dircommon | |
| parent | 10d8555e7db2f4835b4fc9a0f4592e470a974c5f (diff) | |
| download | tor-b0d7b100886ef14a785f6ca1de968df9a884d0a7.tar.gz tor-b0d7b100886ef14a785f6ca1de968df9a884d0a7.zip | |
Improve documentation for our TO_*_CONN() cast functions.
Preliminary work for #40046.
Diffstat (limited to 'src/feature/dircommon')
| -rw-r--r-- | src/feature/dircommon/directory.c | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/src/feature/dircommon/directory.c b/src/feature/dircommon/directory.c index 7f9f157a49..bb9264eaf9 100644 --- a/src/feature/dircommon/directory.c +++ b/src/feature/dircommon/directory.c @@ -79,8 +79,12 @@ * connection_finished_connecting() in connection.c */ -/** Convert a connection_t* to a dir_connection_t*; assert if the cast is - * invalid. */ +/** + * Cast a `connection_t *` to a `dir_connection_t *`. + * + * Exit with an assertion failure if the input is not a + * `dir_connection_t`. + **/ dir_connection_t * TO_DIR_CONN(connection_t *c) { |