diff options
Diffstat (limited to 'src/lib')
46 files changed, 0 insertions, 91 deletions
diff --git a/src/lib/arch/lib_arch.dox b/src/lib/arch/lib_arch.dox index edb0cbbf1d..9b8bccdf16 100644 --- a/src/lib/arch/lib_arch.dox +++ b/src/lib/arch/lib_arch.dox @@ -1,4 +1,2 @@ -/** @dir /lib/arch @brief lib/arch: Compatibility code for handling different CPU architectures. -**/ diff --git a/src/lib/buf/lib_buf.dox b/src/lib/buf/lib_buf.dox index a2ac23ee4c..519ab50a2d 100644 --- a/src/lib/buf/lib_buf.dox +++ b/src/lib/buf/lib_buf.dox @@ -1,4 +1,3 @@ -/** @dir /lib/buf @brief lib/buf: An efficient byte queue. @@ -12,4 +11,3 @@ The buf_t type is also reasonable for use in constructing long strings. See \refdir{lib/net} for networking code that uses buf_t, and \refdir{lib/tls} for cryptographic code that uses buf_t. -**/ diff --git a/src/lib/cc/lib_cc.dox b/src/lib/cc/lib_cc.dox index 06f4e775bf..bd49005ba2 100644 --- a/src/lib/cc/lib_cc.dox +++ b/src/lib/cc/lib_cc.dox @@ -1,4 +1,2 @@ -/** @dir /lib/cc @brief lib/cc: Macros for managing the C compiler and language. -**/ diff --git a/src/lib/compress/lib_compress.dox b/src/lib/compress/lib_compress.dox index 599126901a..c43f223fe7 100644 --- a/src/lib/compress/lib_compress.dox +++ b/src/lib/compress/lib_compress.dox @@ -1,8 +1,6 @@ -/** @dir /lib/compress @brief lib/compress: Wraps several compression libraries Currently supported are zlib (mandatory), zstd (optional), and lzma (optional). -**/ diff --git a/src/lib/conf/lib_conf.dox b/src/lib/conf/lib_conf.dox index be58fe5b55..60dd04e99e 100644 --- a/src/lib/conf/lib_conf.dox +++ b/src/lib/conf/lib_conf.dox @@ -1,5 +1,3 @@ -/** @dir /lib/conf @brief lib/conf: Types and macros for declaring configuration options. -**/ diff --git a/src/lib/confmgt/lib_confmgt.dox b/src/lib/confmgt/lib_confmgt.dox index d18fa304ca..861e720f64 100644 --- a/src/lib/confmgt/lib_confmgt.dox +++ b/src/lib/confmgt/lib_confmgt.dox @@ -1,4 +1,3 @@ -/** @dir /lib/confmgt @brief lib/confmgt: Parse, encode, manipulate configuration files. @@ -6,4 +5,3 @@ This logic is used in common by our state files (statefile.c) and configuration files (config.c) to manage a set of named, typed fields, reading and writing them to disk and to the controller. -**/ diff --git a/src/lib/container/lib_container.dox b/src/lib/container/lib_container.dox index 675aaeef3f..f4902ca44a 100644 --- a/src/lib/container/lib_container.dox +++ b/src/lib/container/lib_container.dox @@ -1,4 +1,3 @@ -/** @dir /lib/container @brief lib/container: Hash tables, dynamic arrays, bit arrays, etc. @@ -48,4 +47,3 @@ cryptographic siphash24g function to extract hashes. <!-- TODO: WRITE about bloom filters, namemaps, bit-arrays, order functions. --> -**/ diff --git a/src/lib/crypt_ops/certs.dox b/src/lib/crypt_ops/certs.dox index 4703f07bcd..2768548b2a 100644 --- a/src/lib/crypt_ops/certs.dox +++ b/src/lib/crypt_ops/certs.dox @@ -1,4 +1,3 @@ -/** @page certificates Certificates in Tor. @@ -29,4 +28,3 @@ documents that include keys and which are signed by keys. You can consider these documents to be an additional kind of certificate if you want.) -**/ diff --git a/src/lib/crypt_ops/lib_crypt_ops.dox b/src/lib/crypt_ops/lib_crypt_ops.dox index 515c67f1c0..4e675e4871 100644 --- a/src/lib/crypt_ops/lib_crypt_ops.dox +++ b/src/lib/crypt_ops/lib_crypt_ops.dox @@ -1,4 +1,3 @@ -/** @dir /lib/crypt_ops @brief lib/crypt_ops: Cryptographic operations. @@ -136,4 +135,3 @@ secret object to disk, encrypted with a passphrase. The crypto_pwbox and crypto_unpwbox functions do so in a way that's likely to be readable by future versions of Tor. -**/ diff --git a/src/lib/ctime/lib_ctime.dox b/src/lib/ctime/lib_ctime.dox index 2bcd0f036a..913199f6a5 100644 --- a/src/lib/ctime/lib_ctime.dox +++ b/src/lib/ctime/lib_ctime.dox @@ -1,4 +1,3 @@ -/** @dir /lib/ctime @brief lib/ctime: Constant-time code to avoid side-channels. @@ -13,4 +12,3 @@ consider calls to memcmp() to be in error, we require that code that actually doesn't need to be constant-time to use the fast_memeq() / fast_memneq() / fast_memcmp() aliases instead. -**/ diff --git a/src/lib/defs/lib_defs.dox b/src/lib/defs/lib_defs.dox index 8ed4d7a0af..5762e4550b 100644 --- a/src/lib/defs/lib_defs.dox +++ b/src/lib/defs/lib_defs.dox @@ -1,4 +1,2 @@ -/** @dir /lib/defs @brief lib/defs: Lowest-level constants, used in many places. -**/ diff --git a/src/lib/dispatch/lib_dispatch.dox b/src/lib/dispatch/lib_dispatch.dox index 955b7df64f..153ca50080 100644 --- a/src/lib/dispatch/lib_dispatch.dox +++ b/src/lib/dispatch/lib_dispatch.dox @@ -1,4 +1,3 @@ -/** @dir /lib/dispatch @brief lib/dispatch: In-process message delivery. @@ -13,4 +12,3 @@ This is not a fancy multi-threaded many-to-many dispatcher as you may be used to from more sophisticated architectures: this dispatcher is intended only for use in improving Tor's architecture. -**/ diff --git a/src/lib/encoding/lib_encoding.dox b/src/lib/encoding/lib_encoding.dox index ca698cb183..66dd9d8caf 100644 --- a/src/lib/encoding/lib_encoding.dox +++ b/src/lib/encoding/lib_encoding.dox @@ -1,8 +1,6 @@ -/** @dir /lib/encoding @brief lib/encoding: Encoding data in various forms, types, and transformations Here we have time formats (timefmt.c), quoted strings (qstring.c), C strings (string.c) base-16/32/64 (binascii.c), and more. -**/ diff --git a/src/lib/err/lib_err.dox b/src/lib/err/lib_err.dox index d1479b1140..cb4eba2e0d 100644 --- a/src/lib/err/lib_err.dox +++ b/src/lib/err/lib_err.dox @@ -1,4 +1,3 @@ -/** @dir /lib/err @brief lib/err: Lowest-level error handling code. @@ -12,4 +11,3 @@ There are three kinds of users for the functions in this module: * Code that needs signal-safe error reporting. * Higher-level error handling code. -**/ diff --git a/src/lib/evloop/lib_evloop.dox b/src/lib/evloop/lib_evloop.dox index 52fcf67755..830be88148 100644 --- a/src/lib/evloop/lib_evloop.dox +++ b/src/lib/evloop/lib_evloop.dox @@ -1,4 +1,3 @@ -/** @dir /lib/evloop @brief lib/evloop: Low-level event loop. @@ -6,4 +5,3 @@ This modules has tools to manage the [libevent](https://libevent.org/) event loop and related functionality, in order to implement asynchronous networking, timers, periodic events, and other scheduling tasks. -**/ diff --git a/src/lib/evloop/time_periodic.dox b/src/lib/evloop/time_periodic.dox index b12ae63bdd..8b3589d9db 100644 --- a/src/lib/evloop/time_periodic.dox +++ b/src/lib/evloop/time_periodic.dox @@ -1,4 +1,3 @@ -/** @page time_periodic Time and periodic events in Tor @@ -75,4 +74,3 @@ platforms. (The timers.c module uses William Ahern's timeout.c implementation as its backend, which is based on a hierarchical timing wheel algorithm. It's cool stuff; check it out.) -**/ diff --git a/src/lib/fdio/lib_fdio.dox b/src/lib/fdio/lib_fdio.dox index 9e2fda617a..9fe4b4d2be 100644 --- a/src/lib/fdio/lib_fdio.dox +++ b/src/lib/fdio/lib_fdio.dox @@ -1,7 +1,5 @@ -/** @dir /lib/fdio @brief lib/fdio: Code to read/write on file descriptors. (This module also handles sockets, on platforms where a socket is not a kind of fd.) -**/ diff --git a/src/lib/fs/lib_fs.dox b/src/lib/fs/lib_fs.dox index 4466250bb8..3b5b0ac7d5 100644 --- a/src/lib/fs/lib_fs.dox +++ b/src/lib/fs/lib_fs.dox @@ -1,4 +1,3 @@ -/** @dir /lib/fs @brief lib/fs: Files, filenames, directories, etc. @@ -8,4 +7,3 @@ operating-system-specific filesystem access. It also contains a set of convenience functions for safely writing to files, creating directories, and so on. -**/ diff --git a/src/lib/geoip/lib_geoip.dox b/src/lib/geoip/lib_geoip.dox index da1123640b..a3ee39d574 100644 --- a/src/lib/geoip/lib_geoip.dox +++ b/src/lib/geoip/lib_geoip.dox @@ -1,5 +1,3 @@ -/** @dir /lib/geoip @brief lib/geoip: IP-to-country mapping -**/ diff --git a/src/lib/intmath/lib_intmath.dox b/src/lib/intmath/lib_intmath.dox index e9b7044706..4446b715cb 100644 --- a/src/lib/intmath/lib_intmath.dox +++ b/src/lib/intmath/lib_intmath.dox @@ -1,4 +1,2 @@ -/** @dir /lib/intmath @brief lib/intmath: Integer mathematics. -**/ diff --git a/src/lib/lib.dox b/src/lib/lib.dox index fdf2c47687..4f77a4c1d0 100644 --- a/src/lib/lib.dox +++ b/src/lib/lib.dox @@ -1,4 +1,3 @@ -/** @dir /lib @brief lib: low-level functionality. @@ -130,4 +129,3 @@ If you are using platform-specific `ifdef`s to manage compatibility issues among platforms, you should probably consider whether you can put your code into lib. -**/ diff --git a/src/lib/lock/lib_lock.dox b/src/lib/lock/lib_lock.dox index 868b5ba7d4..6f6727bfc2 100644 --- a/src/lib/lock/lib_lock.dox +++ b/src/lib/lock/lib_lock.dox @@ -1,8 +1,6 @@ -/** @dir /lib/lock @brief lib/lock: Simple locking support. This module is more low-level than the rest of the threading code, since it is needed by more intermediate-level modules. -**/ diff --git a/src/lib/log/lib_log.dox b/src/lib/log/lib_log.dox index a772dc3207..8740d6a02f 100644 --- a/src/lib/log/lib_log.dox +++ b/src/lib/log/lib_log.dox @@ -1,4 +1,3 @@ -/** @dir /lib/log @brief lib/log: Log messages to files, syslogs, etc. @@ -9,4 +8,3 @@ specifically written to avoid having to log, because the logging module depends on it. -**/ diff --git a/src/lib/malloc/lib_malloc.dox b/src/lib/malloc/lib_malloc.dox index c05e4c6473..ff61722f02 100644 --- a/src/lib/malloc/lib_malloc.dox +++ b/src/lib/malloc/lib_malloc.dox @@ -1,4 +1,3 @@ -/** @dir /lib/malloc @brief lib/malloc: Wrappers and utilities for memory management. @@ -75,4 +74,3 @@ using the FREE_AND_NULL macro, as follows: #define x_free(ptr) FREE_AND_NULL(x_t, x_free_, (ptr)) ``` -**/ diff --git a/src/lib/math/lib_math.dox b/src/lib/math/lib_math.dox index f20d7092b3..9cc256d24b 100644 --- a/src/lib/math/lib_math.dox +++ b/src/lib/math/lib_math.dox @@ -1,8 +1,6 @@ -/** @dir /lib/math @brief lib/math: Floating-point math utilities. This module includes a bunch of floating-point compatibility code, and implementations for several probability distributions. -**/ diff --git a/src/lib/memarea/lib_memarea.dox b/src/lib/memarea/lib_memarea.dox index 041191482d..fe5cb8293f 100644 --- a/src/lib/memarea/lib_memarea.dox +++ b/src/lib/memarea/lib_memarea.dox @@ -1,4 +1,3 @@ -/** @dir /lib/memarea @brief lib/memarea: A fast arena-style allocator. @@ -27,4 +26,3 @@ The allocation functions `memarea_alloc()`, `memarea_alloc_zero()`, to the similarly-named malloc() functions. There is intentionally no `memarea_free()` or `memarea_realloc()`. -**/ diff --git a/src/lib/meminfo/lib_meminfo.dox b/src/lib/meminfo/lib_meminfo.dox index b57e60525e..87f509d648 100644 --- a/src/lib/meminfo/lib_meminfo.dox +++ b/src/lib/meminfo/lib_meminfo.dox @@ -1,7 +1,5 @@ -/** @dir /lib/meminfo @brief lib/meminfo: Inspecting malloc() usage. Only available when malloc() provides mallinfo() or something similar. -**/ diff --git a/src/lib/net/lib_net.dox b/src/lib/net/lib_net.dox index b4c00405d7..b61878d827 100644 --- a/src/lib/net/lib_net.dox +++ b/src/lib/net/lib_net.dox @@ -1,8 +1,6 @@ -/** @dir /lib/net @brief lib/net: Low-level network-related code. This module includes address manipulation, compatibility wrappers, convenience functions, and so on. -**/ diff --git a/src/lib/osinfo/lib_osinfo.dox b/src/lib/osinfo/lib_osinfo.dox index 4d9b1a6d76..0678ecc21e 100644 --- a/src/lib/osinfo/lib_osinfo.dox +++ b/src/lib/osinfo/lib_osinfo.dox @@ -1,4 +1,3 @@ -/** @dir /lib/osinfo @brief lib/osinfo: For inspecting the OS version and capabilities. @@ -7,4 +6,3 @@ system they are running. We shouldn't make decisions based on the output of these checks: instead, we should have more specific checks, either at compile time or run time, based on the observed system behavior. -**/ diff --git a/src/lib/process/lib_process.dox b/src/lib/process/lib_process.dox index 723c9f193d..354129e70e 100644 --- a/src/lib/process/lib_process.dox +++ b/src/lib/process/lib_process.dox @@ -1,4 +1,2 @@ -/** @dir /lib/process @brief lib/process: Launch and manage subprocesses. -**/ diff --git a/src/lib/pubsub/lib_pubsub.dox b/src/lib/pubsub/lib_pubsub.dox index c033660121..3f4c473436 100644 --- a/src/lib/pubsub/lib_pubsub.dox +++ b/src/lib/pubsub/lib_pubsub.dox @@ -1,4 +1,3 @@ -/** @dir /lib/pubsub @brief lib/pubsub: Publish-subscribe message passing. @@ -13,4 +12,3 @@ would be clumsy and tend to complicate the call graph.) See pubsub.c for more information. -**/ diff --git a/src/lib/sandbox/lib_sandbox.dox b/src/lib/sandbox/lib_sandbox.dox index 48eddac685..dd168c9b13 100644 --- a/src/lib/sandbox/lib_sandbox.dox +++ b/src/lib/sandbox/lib_sandbox.dox @@ -1,4 +1,3 @@ -/** @dir /lib/sandbox @brief lib/sandbox: Linux seccomp2-based sandbox. @@ -14,4 +13,3 @@ A better architecture would put the responsibility for invoking tricky system calls (like open()) in another, less restricted process, and give that process responsibility for enforcing our sandbox rules. -**/ diff --git a/src/lib/smartlist_core/lib_smartlist_core.dox b/src/lib/smartlist_core/lib_smartlist_core.dox index 73c3b69056..c031dd6f24 100644 --- a/src/lib/smartlist_core/lib_smartlist_core.dox +++ b/src/lib/smartlist_core/lib_smartlist_core.dox @@ -1,4 +1,3 @@ -/** @dir /lib/smartlist_core @brief lib/smartlist_core: Minimal dynamic array implementation @@ -9,4 +8,3 @@ There are higher-level pieces in \refdir{lib/container} but the ones in lib/smartlist_core are used by the logging code, and therefore cannot use the logging code. -**/ diff --git a/src/lib/string/lib_string.dox b/src/lib/string/lib_string.dox index c8793ddf91..98e3e652ed 100644 --- a/src/lib/string/lib_string.dox +++ b/src/lib/string/lib_string.dox @@ -1,4 +1,3 @@ -/** @dir /lib/string @brief lib/string: Low-level string manipulation. @@ -12,4 +11,3 @@ in the rest of the codebase. Any string function high-level enough to need logging belongs in a higher-level module. -**/ diff --git a/src/lib/string/strings.dox b/src/lib/string/strings.dox index 71c9826800..b22574a05a 100644 --- a/src/lib/string/strings.dox +++ b/src/lib/string/strings.dox @@ -1,4 +1,3 @@ -/** @page strings String processing in Tor diff --git a/src/lib/subsys/initialization.dox b/src/lib/subsys/initialization.dox index 561cd17bab..012ab7000d 100644 --- a/src/lib/subsys/initialization.dox +++ b/src/lib/subsys/initialization.dox @@ -1,4 +1,3 @@ -/** @page initialization Initialization and shutdown @@ -74,4 +73,3 @@ must occur _after_ the initialization process, during configuration. -**/ diff --git a/src/lib/subsys/lib_subsys.dox b/src/lib/subsys/lib_subsys.dox index 1a22a2d808..764d25d1b6 100644 --- a/src/lib/subsys/lib_subsys.dox +++ b/src/lib/subsys/lib_subsys.dox @@ -1,4 +1,3 @@ -/** @dir /lib/subsys @brief lib/subsys: Types for declaring a "subsystem". @@ -31,4 +30,3 @@ that are initialized from `tor_init()` or `run_tor_main_loop()` or these to subsystems over time; please don't add any new code that follows this pattern. -**/ diff --git a/src/lib/term/lib_term.dox b/src/lib/term/lib_term.dox index 3bf2f960ab..f96d25ffe8 100644 --- a/src/lib/term/lib_term.dox +++ b/src/lib/term/lib_term.dox @@ -1,4 +1,2 @@ -/** @dir /lib/term @brief lib/term: Terminal operations (password input). -**/ diff --git a/src/lib/testsupport/lib_testsupport.dox b/src/lib/testsupport/lib_testsupport.dox index c09c32e478..7358e6a80f 100644 --- a/src/lib/testsupport/lib_testsupport.dox +++ b/src/lib/testsupport/lib_testsupport.dox @@ -1,4 +1,2 @@ -/** @dir /lib/testsupport @brief lib/testsupport: Helpers for test-only code and for function mocking. -**/ diff --git a/src/lib/thread/lib_thread.dox b/src/lib/thread/lib_thread.dox index 2773aa009d..5870ad790f 100644 --- a/src/lib/thread/lib_thread.dox +++ b/src/lib/thread/lib_thread.dox @@ -1,4 +1,3 @@ -/** @dir /lib/thread @brief lib/thread: Mid-level threading. @@ -6,4 +5,3 @@ This module contains compatibility and convenience code for multithreading, except for low-level locks (which are in \refdir{lib/lock} and workqueue/threadpool code (which belongs in \refdir{lib/evloop}.) -**/ diff --git a/src/lib/thread/threading.dox b/src/lib/thread/threading.dox index e15d584408..a1058c97de 100644 --- a/src/lib/thread/threading.dox +++ b/src/lib/thread/threading.dox @@ -1,4 +1,3 @@ -/** @page threading Threading in Tor @@ -25,4 +24,3 @@ Try to minimize sharing between threads: it is usually best to simply make the worker "own" all the data it needs while the work is in progress, and to give up ownership when it's complete. -**/ diff --git a/src/lib/time/lib_time.dox b/src/lib/time/lib_time.dox index b76a31fb97..8e58aafcd8 100644 --- a/src/lib/time/lib_time.dox +++ b/src/lib/time/lib_time.dox @@ -1,4 +1,3 @@ -/** @dir /lib/time @brief lib/time: Higher-level time functions @@ -8,4 +7,3 @@ wrappers for them to try to improve efficiency. For "what time is it" in UTC, see \refdir{lib/wallclock}. For parsing and encoding times and dates, see \refdir{lib/encoding}. -**/ diff --git a/src/lib/tls/lib_tls.dox b/src/lib/tls/lib_tls.dox index f0dba269e8..26fea723f9 100644 --- a/src/lib/tls/lib_tls.dox +++ b/src/lib/tls/lib_tls.dox @@ -1,4 +1,3 @@ -/** @dir /lib/tls @brief lib/tls: TLS library wrappers @@ -10,4 +9,3 @@ It also implements the logic for some legacy TLS protocol usage we used to support in old versions of Tor, involving conditional delivery of certificate chains (v1 link protocol) and conditional renegotiation (v2 link protocol). -**/ diff --git a/src/lib/trace/lib_trace.dox b/src/lib/trace/lib_trace.dox index 64f762bc3e..a7a32529b0 100644 --- a/src/lib/trace/lib_trace.dox +++ b/src/lib/trace/lib_trace.dox @@ -1,8 +1,6 @@ -/** @dir /lib/trace @brief lib/trace: Function-tracing functionality API. This module is used for adding "trace" support (low-granularity function logging) to Tor. Right now it doesn't have many users. -**/ diff --git a/src/lib/version/lib_version.dox b/src/lib/version/lib_version.dox index 93d2fb6b9b..ccc45920f9 100644 --- a/src/lib/version/lib_version.dox +++ b/src/lib/version/lib_version.dox @@ -1,4 +1,2 @@ -/** @dir /lib/version @brief lib/version: holds the current version of Tor. -**/ diff --git a/src/lib/wallclock/lib_wallclock.dox b/src/lib/wallclock/lib_wallclock.dox index 7d43fa6129..f21721f6f6 100644 --- a/src/lib/wallclock/lib_wallclock.dox +++ b/src/lib/wallclock/lib_wallclock.dox @@ -1,4 +1,3 @@ -/** @dir /lib/wallclock @brief lib/wallclock: Inspect and manipulate the current time. @@ -10,4 +9,3 @@ For versions of the time that are more local, more monotonic, or more accurate, see \refdir{lib/time}. For parsing and encoding times and dates, see \refdir{lib/encoding}. -**/ |