diff options
| author | Nick Mathewson <nickm@torproject.org> | 2018-07-01 20:22:55 -0400 |
|---|---|---|
| committer | Nick Mathewson <nickm@torproject.org> | 2018-07-01 20:22:55 -0400 |
| commit | cb1a3674ebb3826d9e1e56146210bd79cb4a42f0 (patch) | |
| tree | 84382a222e7d271efb8426560b61fb1a28ec4e05 /src/lib/lock | |
| parent | 83a4946e7b9d2bb75ab8dfa8073c5dd7b3f77bc9 (diff) | |
| download | tor-cb1a3674ebb3826d9e1e56146210bd79cb4a42f0.tar.gz tor-cb1a3674ebb3826d9e1e56146210bd79cb4a42f0.zip | |
File-level documentation for some of src/lib.
Diffstat (limited to 'src/lib/lock')
| -rw-r--r-- | src/lib/lock/compat_mutex.c | 6 | ||||
| -rw-r--r-- | src/lib/lock/compat_mutex.h | 6 | ||||
| -rw-r--r-- | src/lib/lock/compat_mutex_pthreads.c | 6 | ||||
| -rw-r--r-- | src/lib/lock/compat_mutex_winthreads.c | 6 |
4 files changed, 24 insertions, 0 deletions
diff --git a/src/lib/lock/compat_mutex.c b/src/lib/lock/compat_mutex.c index e0f6224a83..bfab6dd29b 100644 --- a/src/lib/lock/compat_mutex.c +++ b/src/lib/lock/compat_mutex.c @@ -3,6 +3,12 @@ * Copyright (c) 2007-2018, The Tor Project, Inc. */ /* See LICENSE for licensing information */ +/** + * \file compat_mutex.c + * + * \brief Portable wrapper for platform mutex implementations. + **/ + #include "lib/lock/compat_mutex.h" #include "lib/malloc/util_malloc.h" diff --git a/src/lib/lock/compat_mutex.h b/src/lib/lock/compat_mutex.h index 92978086ac..f467aa5dba 100644 --- a/src/lib/lock/compat_mutex.h +++ b/src/lib/lock/compat_mutex.h @@ -3,6 +3,12 @@ * Copyright (c) 2007-2018, The Tor Project, Inc. */ /* See LICENSE for licensing information */ +/** + * \file compat_mutex.h + * + * \brief Header for compat_mutex.c + **/ + #ifndef TOR_COMPAT_MUTEX_H #define TOR_COMPAT_MUTEX_H diff --git a/src/lib/lock/compat_mutex_pthreads.c b/src/lib/lock/compat_mutex_pthreads.c index 390da4fb81..983abf5ae5 100644 --- a/src/lib/lock/compat_mutex_pthreads.c +++ b/src/lib/lock/compat_mutex_pthreads.c @@ -3,6 +3,12 @@ * Copyright (c) 2007-2018, The Tor Project, Inc. */ /* See LICENSE for licensing information */ +/** + * \file compat_mutex_pthreads.c + * + * \brief Implement the tor_mutex API using pthread_mutex_t. + **/ + #include "lib/lock/compat_mutex.h" #include "lib/cc/compat_compiler.h" #include "lib/err/torerr.h" diff --git a/src/lib/lock/compat_mutex_winthreads.c b/src/lib/lock/compat_mutex_winthreads.c index 32be288c7f..22c1edeed4 100644 --- a/src/lib/lock/compat_mutex_winthreads.c +++ b/src/lib/lock/compat_mutex_winthreads.c @@ -3,6 +3,12 @@ * Copyright (c) 2007-2018, The Tor Project, Inc. */ /* See LICENSE for licensing information */ +/** + * \file compat_mutex_winthreads.c + * + * \brief Implement the tor_mutex API using CRITICAL_SECTION. + **/ + #include "lib/lock/compat_mutex.h" #include "lib/err/torerr.h" |