commit 3a7369d0cfa567cdb02063e1dad176c92ef2c7fe Author: Nick Mathewson nickm@torproject.org Date: Fri Nov 15 09:23:51 2019 -0500

Doxygen: remove /** and **/ from all .dox files

This is an automatically generated commit, made with:

find src -name '*.dox' | \ xargs perl -i -ne 'print unless (m#^\s*/?**/?\s*$#);' --- src/app/app.dox | 2 -- src/app/config/app_config.dox | 2 -- src/app/main/app_main.dox | 2 -- src/core/core.dox | 2 -- src/core/crypto/core_crypto.dox | 2 -- src/core/mainloop/core_mainloop.dox | 2 -- src/core/or/core_or.dox | 2 -- src/core/or/dataflow.dox | 2 -- src/core/proto/core_proto.dox | 2 -- src/feature/api/feature_api.dox | 2 -- src/feature/client/feature_client.dox | 2 -- src/feature/control/feature_control.dox | 2 -- src/feature/dirauth/feature_dirauth.dox | 2 -- src/feature/dircache/feature_dircache.dox | 2 -- src/feature/dirclient/feature_dirclient.dox | 2 -- src/feature/dircommon/feature_dircommon.dox | 2 -- src/feature/dirparse/feature_dirparse.dox | 2 -- src/feature/feature.dox | 2 -- src/feature/hibernate/feature_hibernate.dox | 2 -- src/feature/hs/feature_hs.dox | 2 -- src/feature/hs_common/feature_hs_common.dox | 2 -- src/feature/keymgt/feature_keymgt.dox | 2 -- src/feature/nodelist/feature_nodelist.dox | 2 -- src/feature/relay/feature_relay.dox | 2 -- src/feature/rend/feature_rend.dox | 2 -- src/feature/stats/feature_stats.dox | 2 -- src/lib/arch/lib_arch.dox | 2 -- src/lib/buf/lib_buf.dox | 2 -- src/lib/cc/lib_cc.dox | 2 -- src/lib/compress/lib_compress.dox | 2 -- src/lib/conf/lib_conf.dox | 2 -- src/lib/confmgt/lib_confmgt.dox | 2 -- src/lib/container/lib_container.dox | 2 -- src/lib/crypt_ops/certs.dox | 2 -- src/lib/crypt_ops/lib_crypt_ops.dox | 2 -- src/lib/ctime/lib_ctime.dox | 2 -- src/lib/defs/lib_defs.dox | 2 -- src/lib/dispatch/lib_dispatch.dox | 2 -- src/lib/encoding/lib_encoding.dox | 2 -- src/lib/err/lib_err.dox | 2 -- src/lib/evloop/lib_evloop.dox | 2 -- src/lib/evloop/time_periodic.dox | 2 -- src/lib/fdio/lib_fdio.dox | 2 -- src/lib/fs/lib_fs.dox | 2 -- src/lib/geoip/lib_geoip.dox | 2 -- src/lib/intmath/lib_intmath.dox | 2 -- src/lib/lib.dox | 2 -- src/lib/lock/lib_lock.dox | 2 -- src/lib/log/lib_log.dox | 2 -- src/lib/malloc/lib_malloc.dox | 2 -- src/lib/math/lib_math.dox | 2 -- src/lib/memarea/lib_memarea.dox | 2 -- src/lib/meminfo/lib_meminfo.dox | 2 -- src/lib/net/lib_net.dox | 2 -- src/lib/osinfo/lib_osinfo.dox | 2 -- src/lib/process/lib_process.dox | 2 -- src/lib/pubsub/lib_pubsub.dox | 2 -- src/lib/sandbox/lib_sandbox.dox | 2 -- src/lib/smartlist_core/lib_smartlist_core.dox | 2 -- src/lib/string/lib_string.dox | 2 -- src/lib/string/strings.dox | 1 - src/lib/subsys/initialization.dox | 2 -- src/lib/subsys/lib_subsys.dox | 2 -- src/lib/term/lib_term.dox | 2 -- src/lib/testsupport/lib_testsupport.dox | 2 -- src/lib/thread/lib_thread.dox | 2 -- src/lib/thread/threading.dox | 2 -- src/lib/time/lib_time.dox | 2 -- src/lib/tls/lib_tls.dox | 2 -- src/lib/trace/lib_trace.dox | 2 -- src/lib/version/lib_version.dox | 2 -- src/lib/wallclock/lib_wallclock.dox | 2 -- src/mainpage.dox | 4 ---- src/tools/tools.dox | 2 -- 74 files changed, 149 deletions(-)

diff --git a/src/app/app.dox b/src/app/app.dox index 21d5791cd..138e75b12 100644 --- a/src/app/app.dox +++ b/src/app/app.dox @@ -1,8 +1,6 @@ -/** @dir /app @brief app: top-level entry point for Tor

The "app" directory has Tor's main entry point and configuration logic, and is responsible for initializing and managing the other modules in Tor. -**/ diff --git a/src/app/config/app_config.dox b/src/app/config/app_config.dox index ef4a87827..b359ce77f 100644 --- a/src/app/config/app_config.dox +++ b/src/app/config/app_config.dox @@ -1,8 +1,6 @@ -/** @dir /app/config @brief app/config: Top-level configuration code

Refactoring this module is a work in progress, see [ticket 29211](https://trac.torproject.org/projects/tor/ticket/29211).

-**/ diff --git a/src/app/main/app_main.dox b/src/app/main/app_main.dox index c714ad139..b8c789716 100644 --- a/src/app/main/app_main.dox +++ b/src/app/main/app_main.dox @@ -1,4 +1,2 @@ -/** @dir /app/main @brief app/main: Entry point for tor. -**/ diff --git a/src/core/core.dox b/src/core/core.dox index 11bf55cb7..8ecc43eaa 100644 --- a/src/core/core.dox +++ b/src/core/core.dox @@ -1,4 +1,3 @@ -/** @dir /core @brief core: main loop and onion routing functionality

@@ -17,4 +16,3 @@ and one high-level piece:

- \refdir{core/or} -- Implements onion routing itself.

-**/ diff --git a/src/core/crypto/core_crypto.dox b/src/core/crypto/core_crypto.dox index 28ece92bb..26ade1f8f 100644 --- a/src/core/crypto/core_crypto.dox +++ b/src/core/crypto/core_crypto.dox @@ -1,8 +1,6 @@ -/** @dir /core/crypto @brief core/crypto: Tor-specific cryptography

This module implements Tor's circuit-construction crypto and Tor's relay crypto.

-**/ diff --git a/src/core/mainloop/core_mainloop.dox b/src/core/mainloop/core_mainloop.dox index 28cd42bf6..fee8a8179 100644 --- a/src/core/mainloop/core_mainloop.dox +++ b/src/core/mainloop/core_mainloop.dox @@ -1,4 +1,3 @@ -/** @dir /core/mainloop @brief core/mainloop: Non-onion-routing mainloop functionality

@@ -9,4 +8,3 @@ The layering here is imperfect: the code here was split from \refdir{core/or} without refactoring how the two modules call one another. Probably many functions should be moved and refactored.

-**/ diff --git a/src/core/or/core_or.dox b/src/core/or/core_or.dox index 7272f7680..0b4d430a0 100644 --- a/src/core/or/core_or.dox +++ b/src/core/or/core_or.dox @@ -1,4 +1,3 @@ -/** @dir core/or @brief core/or: **Onion routing happens here!**

@@ -61,4 +60,3 @@ encrypt, route, and interpret relay cells. `scheduler.c` : Decides which channel/circuit pair is ready to receive the next cell.

-**/ diff --git a/src/core/or/dataflow.dox b/src/core/or/dataflow.dox index 3b32bb30f..109870178 100644 --- a/src/core/or/dataflow.dox +++ b/src/core/or/dataflow.dox @@ -1,4 +1,3 @@ -/** @tableofcontents

@page dataflow Data flow in the Tor process @@ -235,4 +234,3 @@ queue the next cell. (This logic applies to outgoing relay cells only; incoming relay cells are processed as they arrive.)

-**/ diff --git a/src/core/proto/core_proto.dox b/src/core/proto/core_proto.dox index 13ce751a7..ad43bc584 100644 --- a/src/core/proto/core_proto.dox +++ b/src/core/proto/core_proto.dox @@ -1,8 +1,6 @@ -/** @dir /core/proto @brief core/proto: Protocol encoding/decoding

These functions should (but do not always) exist at a lower level than most of the rest of core.

-**/ diff --git a/src/feature/api/feature_api.dox b/src/feature/api/feature_api.dox index 06112120c..3065c000a 100644 --- a/src/feature/api/feature_api.dox +++ b/src/feature/api/feature_api.dox @@ -1,4 +1,2 @@ -/** @dir /feature/api @brief feature/api: In-process interface to starting/stopping Tor. -**/ diff --git a/src/feature/client/feature_client.dox b/src/feature/client/feature_client.dox index a8263b494..dd4bf78ec 100644 --- a/src/feature/client/feature_client.dox +++ b/src/feature/client/feature_client.dox @@ -1,7 +1,5 @@ -/** @dir /feature/client @brief feature/client: Client-specific code

(There is also a bunch of client-specific code in other modules.)

-**/ diff --git a/src/feature/control/feature_control.dox b/src/feature/control/feature_control.dox index a0bf9413a..9f1681ea9 100644 --- a/src/feature/control/feature_control.dox +++ b/src/feature/control/feature_control.dox @@ -1,4 +1,3 @@ -/** @dir /feature/control @brief feature/control: Controller API.

@@ -7,4 +6,3 @@ thread, if you're running Tor in-process) can use to configure and control Tor while it is running. The current protocol is documented in [control-spec.txt](https://gitweb.torproject.org/torspec.git/tree/control-spec.txt).

-**/ diff --git a/src/feature/dirauth/feature_dirauth.dox b/src/feature/dirauth/feature_dirauth.dox index 9ee2d0458..b152b9489 100644 --- a/src/feature/dirauth/feature_dirauth.dox +++ b/src/feature/dirauth/feature_dirauth.dox @@ -1,4 +1,3 @@ -/** @dir /feature/dirauth @brief feature/dirauth: Directory authority implementation.

@@ -8,4 +7,3 @@ The directory protocol is specified in [dir-spec.txt](https://gitweb.torproject.org/torspec.git/tree/dir-spec.txt).

-**/ diff --git a/src/feature/dircache/feature_dircache.dox b/src/feature/dircache/feature_dircache.dox index ef8a51aa9..97734f2a3 100644 --- a/src/feature/dircache/feature_dircache.dox +++ b/src/feature/dircache/feature_dircache.dox @@ -1,8 +1,6 @@ -/** @dir /feature/dircache @brief feature/dircache: Run as a directory cache server

This module handles the directory caching functionality that all relays may provide, for serving cached directory objects to objects.

-**/ diff --git a/src/feature/dirclient/feature_dirclient.dox b/src/feature/dirclient/feature_dirclient.dox index 0cbae6911..5c7ee964d 100644 --- a/src/feature/dirclient/feature_dirclient.dox +++ b/src/feature/dirclient/feature_dirclient.dox @@ -1,4 +1,3 @@ -/** @dir /feature/dirclient @brief feature/dirclient: Directory client implementation.

@@ -6,4 +5,3 @@ The code here is used by all Tor instances that need to download directory information. Currently, that is all of them, since even authorities need to launch downloads to learn about relays that other authorities have listed.

-**/ diff --git a/src/feature/dircommon/feature_dircommon.dox b/src/feature/dircommon/feature_dircommon.dox index 2d9866da0..359049ecd 100644 --- a/src/feature/dircommon/feature_dircommon.dox +++ b/src/feature/dircommon/feature_dircommon.dox @@ -1,4 +1,3 @@ -/** @dir /feature/dircommon @brief feature/dircommon: Directory client and server shared code

@@ -6,4 +5,3 @@ This module has the code that directory clients (anybody who download information about relays) and directory servers (anybody who serves such information) share in common.

-**/ diff --git a/src/feature/dirparse/feature_dirparse.dox b/src/feature/dirparse/feature_dirparse.dox index 4f2136b02..e4b34668b 100644 --- a/src/feature/dirparse/feature_dirparse.dox +++ b/src/feature/dirparse/feature_dirparse.dox @@ -1,4 +1,3 @@ -/** @dir /feature/dirparse @brief feature/dirparse: Parsing Tor directory objects

@@ -7,4 +6,3 @@ We define a number of "directory objects" in all of them using a common line-oriented meta-format. This module is used by other parts of Tor to parse them.

-**/ diff --git a/src/feature/feature.dox b/src/feature/feature.dox index 03759f9a1..acc3487e5 100644 --- a/src/feature/feature.dox +++ b/src/feature/feature.dox @@ -1,4 +1,3 @@ -/** @dir /feature @brief feature: domain-specific modules

@@ -6,4 +5,3 @@ The "feature" directory has modules that Tor uses only for a particular role or service, such as maintaining/using an onion service, operating as a relay or a client, or being a directory authority.

-**/ diff --git a/src/feature/hibernate/feature_hibernate.dox b/src/feature/hibernate/feature_hibernate.dox index eebb2d51a..0eb5ffea0 100644 --- a/src/feature/hibernate/feature_hibernate.dox +++ b/src/feature/hibernate/feature_hibernate.dox @@ -1,4 +1,3 @@ -/** @dir /feature/hibernate @brief feature/hibernate: Bandwidth accounting and hibernation (!)

@@ -13,4 +12,3 @@ The two features are related only in the sense that "soft hibernation" (being almost out of ) is very close to the "shutting down" state. But it would be better in the long run to make the two completely separate.

-**/ diff --git a/src/feature/hs/feature_hs.dox b/src/feature/hs/feature_hs.dox index 32f44d57f..299d07e01 100644 --- a/src/feature/hs/feature_hs.dox +++ b/src/feature/hs/feature_hs.dox @@ -1,4 +1,3 @@ -/** @dir /feature/hs @brief feature/hs: v3 (current) onion service protocol

@@ -7,4 +6,3 @@ as specified in [rend-spec-v3.txt](https://gitweb.torproject.org/torspec.git/tree/rend-spec-v3.txt).

-**/ diff --git a/src/feature/hs_common/feature_hs_common.dox b/src/feature/hs_common/feature_hs_common.dox index 85d758587..3a5e351a0 100644 --- a/src/feature/hs_common/feature_hs_common.dox +++ b/src/feature/hs_common/feature_hs_common.dox @@ -1,5 +1,3 @@ -/** @dir /feature/hs_common @brief feature/hs_common: Common to v2 (old) and v3 (current) onion services

-**/ diff --git a/src/feature/keymgt/feature_keymgt.dox b/src/feature/keymgt/feature_keymgt.dox index acc840eb2..1eac7cca5 100644 --- a/src/feature/keymgt/feature_keymgt.dox +++ b/src/feature/keymgt/feature_keymgt.dox @@ -1,5 +1,3 @@ -/** @dir /feature/keymgt @brief feature/keymgt: Store keys for relays, authorities, etc.

-**/ diff --git a/src/feature/nodelist/feature_nodelist.dox b/src/feature/nodelist/feature_nodelist.dox index 0b25dd246..9d715308c 100644 --- a/src/feature/nodelist/feature_nodelist.dox +++ b/src/feature/nodelist/feature_nodelist.dox @@ -1,4 +1,2 @@ -/** @dir /feature/nodelist @brief feature/nodelist: Download and manage a list of relays -**/ diff --git a/src/feature/relay/feature_relay.dox b/src/feature/relay/feature_relay.dox index 686781825..a7f0c2153 100644 --- a/src/feature/relay/feature_relay.dox +++ b/src/feature/relay/feature_relay.dox @@ -1,6 +1,4 @@ -/** @dir /feature/relay @brief feature/relay: Relay-specific code

(There is also a bunch of relay-specific code in other modules.) -**/ diff --git a/src/feature/rend/feature_rend.dox b/src/feature/rend/feature_rend.dox index ed0784521..bfd8ae3db 100644 --- a/src/feature/rend/feature_rend.dox +++ b/src/feature/rend/feature_rend.dox @@ -1,4 +1,3 @@ -/** @dir /feature/rend @brief feature/rend: version 2 (old) hidden services

@@ -6,4 +5,3 @@ This directory implements the v2 onion service protocol, as specified in [rend-spec-v2.txt](https://gitweb.torproject.org/torspec.git/tree/rend-spec-v2.txt).

-**/ diff --git a/src/feature/stats/feature_stats.dox b/src/feature/stats/feature_stats.dox index 0ced00ce5..d205fe557 100644 --- a/src/feature/stats/feature_stats.dox +++ b/src/feature/stats/feature_stats.dox @@ -1,4 +1,3 @@ -/** @dir /feature/stats @brief feature/stats: Relay statistics. Also, port prediction.

@@ -9,4 +8,3 @@ Additionally, it contains predict_ports.c, which remembers which ports we've visited recently as a client, so we can make sure we have open circuits that support them.

-**/ diff --git a/src/lib/arch/lib_arch.dox b/src/lib/arch/lib_arch.dox index edb0cbbf1..9b8bccdf1 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 a2ac23ee4..519ab50a2 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 06f4e775b..bd49005ba 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 599126901..c43f223fe 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 be58fe5b5..60dd04e99 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 d18fa304c..861e720f6 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 675aaeef3..f4902ca44 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 4703f07bc..2768548b2 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 515c67f1c..4e675e487 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 2bcd0f036..913199f6a 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 8ed4d7a0a..5762e4550 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 955b7df64..153ca5008 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 ca698cb18..66dd9d8ca 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 d1479b114..cb4eba2e0 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 52fcf6775..830be8814 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 b12ae63bd..8b3589d9d 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 9e2fda617..9fe4b4d2b 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 4466250bb..3b5b0ac7d 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 da1123640..a3ee39d57 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 e9b704470..4446b715c 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 fdf2c4768..4f77a4c1d 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 868b5ba7d..6f6727bfc 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 a772dc320..8740d6a02 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 c05e4c647..ff61722f0 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 f20d7092b..9cc256d24 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 041191482..fe5cb8293 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 b57e60525..87f509d64 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 b4c00405d..b61878d82 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 4d9b1a6d7..0678ecc21 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 723c9f193..354129e70 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 c03366012..3f4c47343 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 48eddac68..dd168c9b1 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 73c3b6905..c031dd6f2 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 c8793ddf9..98e3e652e 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 71c982680..b22574a05 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 561cd17ba..012ab7000 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 1a22a2d80..764d25d1b 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 3bf2f960a..f96d25ffe 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 c09c32e47..7358e6a80 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 2773aa009..5870ad790 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 e15d58440..a1058c97d 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 b76a31fb9..8e58aafcd 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 f0dba269e..26fea723f 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 64f762bc3..a7a32529b 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 93d2fb6b9..ccc45920f 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 7d43fa612..f21721f6f 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}.

-**/ diff --git a/src/mainpage.dox b/src/mainpage.dox index e3b17cf16..a2c5ec630 100644 --- a/src/mainpage.dox +++ b/src/mainpage.dox @@ -1,4 +1,3 @@ -/** @mainpage Tor source reference

@tableofcontents @@ -42,9 +41,7 @@ Tor repository.

@subpage time_periodic

-**/

-/** @page intro A high-level overview

@tableofcontents @@ -144,4 +141,3 @@ more connection types. A 'Node' (node_t) is a view of a Tor instance's current knowledge and opinions about a Tor relay or bridge.

-**/ diff --git a/src/tools/tools.dox b/src/tools/tools.dox index 1168ed5ba..1f0038167 100644 --- a/src/tools/tools.dox +++ b/src/tools/tools.dox @@ -1,8 +1,6 @@ -/** @dir /tools @brief tools: other command-line tools for use with Tor.

The "tools" directory has a few other programs that use Tor, but are not part of the main Tor binary.

-**/