mirror of
https://gitlab.torproject.org/tpo/core/tor.git
synced 2025-02-25 15:10:48 +01:00
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*$#);'
This commit is contained in:
parent
625ad65382
commit
3a7369d0cf
74 changed files with 0 additions and 149 deletions
|
@ -1,8 +1,6 @@
|
||||||
/**
|
|
||||||
@dir /app
|
@dir /app
|
||||||
@brief app: top-level entry point for Tor
|
@brief app: top-level entry point for Tor
|
||||||
|
|
||||||
The "app" directory has Tor's main entry point and configuration logic,
|
The "app" directory has Tor's main entry point and configuration logic,
|
||||||
and is responsible for initializing and managing the other modules in
|
and is responsible for initializing and managing the other modules in
|
||||||
Tor.
|
Tor.
|
||||||
**/
|
|
||||||
|
|
|
@ -1,8 +1,6 @@
|
||||||
/**
|
|
||||||
@dir /app/config
|
@dir /app/config
|
||||||
@brief app/config: Top-level configuration code
|
@brief app/config: Top-level configuration code
|
||||||
|
|
||||||
Refactoring this module is a work in progress, see
|
Refactoring this module is a work in progress, see
|
||||||
[ticket 29211](https://trac.torproject.org/projects/tor/ticket/29211).
|
[ticket 29211](https://trac.torproject.org/projects/tor/ticket/29211).
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,4 +1,2 @@
|
||||||
/**
|
|
||||||
@dir /app/main
|
@dir /app/main
|
||||||
@brief app/main: Entry point for tor.
|
@brief app/main: Entry point for tor.
|
||||||
**/
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
/**
|
|
||||||
@dir /core
|
@dir /core
|
||||||
@brief core: main loop and onion routing functionality
|
@brief core: main loop and onion routing functionality
|
||||||
|
|
||||||
|
@ -17,4 +16,3 @@ and one high-level piece:
|
||||||
|
|
||||||
- \refdir{core/or} -- Implements onion routing itself.
|
- \refdir{core/or} -- Implements onion routing itself.
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,8 +1,6 @@
|
||||||
/**
|
|
||||||
@dir /core/crypto
|
@dir /core/crypto
|
||||||
@brief core/crypto: Tor-specific cryptography
|
@brief core/crypto: Tor-specific cryptography
|
||||||
|
|
||||||
This module implements Tor's circuit-construction crypto and Tor's
|
This module implements Tor's circuit-construction crypto and Tor's
|
||||||
relay crypto.
|
relay crypto.
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
/**
|
|
||||||
@dir /core/mainloop
|
@dir /core/mainloop
|
||||||
@brief core/mainloop: Non-onion-routing mainloop functionality
|
@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
|
without refactoring how the two modules call one another. Probably many
|
||||||
functions should be moved and refactored.
|
functions should be moved and refactored.
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
/**
|
|
||||||
@dir core/or
|
@dir core/or
|
||||||
@brief core/or: **Onion routing happens here!**
|
@brief core/or: **Onion routing happens here!**
|
||||||
|
|
||||||
|
@ -61,4 +60,3 @@ encrypt, route, and interpret relay cells.
|
||||||
`scheduler.c`
|
`scheduler.c`
|
||||||
: Decides which channel/circuit pair is ready to receive the next cell.
|
: Decides which channel/circuit pair is ready to receive the next cell.
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
/**
|
|
||||||
@tableofcontents
|
@tableofcontents
|
||||||
|
|
||||||
@page dataflow Data flow in the Tor process
|
@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
|
(This logic applies to outgoing relay cells only; incoming relay cells
|
||||||
are processed as they arrive.)
|
are processed as they arrive.)
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,8 +1,6 @@
|
||||||
/**
|
|
||||||
@dir /core/proto
|
@dir /core/proto
|
||||||
@brief core/proto: Protocol encoding/decoding
|
@brief core/proto: Protocol encoding/decoding
|
||||||
|
|
||||||
These functions should (but do not always) exist at a lower level than most
|
These functions should (but do not always) exist at a lower level than most
|
||||||
of the rest of core.
|
of the rest of core.
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,4 +1,2 @@
|
||||||
/**
|
|
||||||
@dir /feature/api
|
@dir /feature/api
|
||||||
@brief feature/api: In-process interface to starting/stopping Tor.
|
@brief feature/api: In-process interface to starting/stopping Tor.
|
||||||
**/
|
|
||||||
|
|
|
@ -1,7 +1,5 @@
|
||||||
/**
|
|
||||||
@dir /feature/client
|
@dir /feature/client
|
||||||
@brief feature/client: Client-specific code
|
@brief feature/client: Client-specific code
|
||||||
|
|
||||||
(There is also a bunch of client-specific code in other modules.)
|
(There is also a bunch of client-specific code in other modules.)
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
/**
|
|
||||||
@dir /feature/control
|
@dir /feature/control
|
||||||
@brief feature/control: Controller API.
|
@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
|
Tor while it is running. The current protocol is documented in
|
||||||
[control-spec.txt](https://gitweb.torproject.org/torspec.git/tree/control-spec.txt).
|
[control-spec.txt](https://gitweb.torproject.org/torspec.git/tree/control-spec.txt).
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
/**
|
|
||||||
@dir /feature/dirauth
|
@dir /feature/dirauth
|
||||||
@brief feature/dirauth: Directory authority implementation.
|
@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).
|
[dir-spec.txt](https://gitweb.torproject.org/torspec.git/tree/dir-spec.txt).
|
||||||
|
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,8 +1,6 @@
|
||||||
/**
|
|
||||||
@dir /feature/dircache
|
@dir /feature/dircache
|
||||||
@brief feature/dircache: Run as a directory cache server
|
@brief feature/dircache: Run as a directory cache server
|
||||||
|
|
||||||
This module handles the directory caching functionality that all relays may
|
This module handles the directory caching functionality that all relays may
|
||||||
provide, for serving cached directory objects to objects.
|
provide, for serving cached directory objects to objects.
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
/**
|
|
||||||
@dir /feature/dirclient
|
@dir /feature/dirclient
|
||||||
@brief feature/dirclient: Directory client implementation.
|
@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
|
information. Currently, that is all of them, since even authorities need to
|
||||||
launch downloads to learn about relays that other authorities have listed.
|
launch downloads to learn about relays that other authorities have listed.
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
/**
|
|
||||||
@dir /feature/dircommon
|
@dir /feature/dircommon
|
||||||
@brief feature/dircommon: Directory client and server shared code
|
@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 about relays) and directory servers (anybody who serves such
|
||||||
information) share in common.
|
information) share in common.
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
/**
|
|
||||||
@dir /feature/dirparse
|
@dir /feature/dirparse
|
||||||
@brief feature/dirparse: Parsing Tor directory objects
|
@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
|
all of them using a common line-oriented meta-format. This module is used by
|
||||||
other parts of Tor to parse them.
|
other parts of Tor to parse them.
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
/**
|
|
||||||
@dir /feature
|
@dir /feature
|
||||||
@brief feature: domain-specific modules
|
@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
|
role or service, such as maintaining/using an onion service, operating as a
|
||||||
relay or a client, or being a directory authority.
|
relay or a client, or being a directory authority.
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
/**
|
|
||||||
@dir /feature/hibernate
|
@dir /feature/hibernate
|
||||||
@brief feature/hibernate: Bandwidth accounting and hibernation (!)
|
@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
|
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.
|
better in the long run to make the two completely separate.
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
/**
|
|
||||||
@dir /feature/hs
|
@dir /feature/hs
|
||||||
@brief feature/hs: v3 (current) onion service protocol
|
@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).
|
[rend-spec-v3.txt](https://gitweb.torproject.org/torspec.git/tree/rend-spec-v3.txt).
|
||||||
|
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,5 +1,3 @@
|
||||||
/**
|
|
||||||
@dir /feature/hs_common
|
@dir /feature/hs_common
|
||||||
@brief feature/hs_common: Common to v2 (old) and v3 (current) onion services
|
@brief feature/hs_common: Common to v2 (old) and v3 (current) onion services
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,5 +1,3 @@
|
||||||
/**
|
|
||||||
@dir /feature/keymgt
|
@dir /feature/keymgt
|
||||||
@brief feature/keymgt: Store keys for relays, authorities, etc.
|
@brief feature/keymgt: Store keys for relays, authorities, etc.
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,4 +1,2 @@
|
||||||
/**
|
|
||||||
@dir /feature/nodelist
|
@dir /feature/nodelist
|
||||||
@brief feature/nodelist: Download and manage a list of relays
|
@brief feature/nodelist: Download and manage a list of relays
|
||||||
**/
|
|
||||||
|
|
|
@ -1,6 +1,4 @@
|
||||||
/**
|
|
||||||
@dir /feature/relay
|
@dir /feature/relay
|
||||||
@brief feature/relay: Relay-specific code
|
@brief feature/relay: Relay-specific code
|
||||||
|
|
||||||
(There is also a bunch of relay-specific code in other modules.)
|
(There is also a bunch of relay-specific code in other modules.)
|
||||||
**/
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
/**
|
|
||||||
@dir /feature/rend
|
@dir /feature/rend
|
||||||
@brief feature/rend: version 2 (old) hidden services
|
@brief feature/rend: version 2 (old) hidden services
|
||||||
|
|
||||||
|
@ -6,4 +5,3 @@ This directory implements the v2 onion service protocol,
|
||||||
as specified in
|
as specified in
|
||||||
[rend-spec-v2.txt](https://gitweb.torproject.org/torspec.git/tree/rend-spec-v2.txt).
|
[rend-spec-v2.txt](https://gitweb.torproject.org/torspec.git/tree/rend-spec-v2.txt).
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
/**
|
|
||||||
@dir /feature/stats
|
@dir /feature/stats
|
||||||
@brief feature/stats: Relay statistics. Also, port prediction.
|
@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
|
visited recently as a client, so we can make sure we have open circuits that
|
||||||
support them.
|
support them.
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,4 +1,2 @@
|
||||||
/**
|
|
||||||
@dir /lib/arch
|
@dir /lib/arch
|
||||||
@brief lib/arch: Compatibility code for handling different CPU architectures.
|
@brief lib/arch: Compatibility code for handling different CPU architectures.
|
||||||
**/
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
/**
|
|
||||||
@dir /lib/buf
|
@dir /lib/buf
|
||||||
@brief lib/buf: An efficient byte queue.
|
@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
|
See \refdir{lib/net} for networking code that uses buf_t, and
|
||||||
\refdir{lib/tls} for cryptographic code that uses buf_t.
|
\refdir{lib/tls} for cryptographic code that uses buf_t.
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,4 +1,2 @@
|
||||||
/**
|
|
||||||
@dir /lib/cc
|
@dir /lib/cc
|
||||||
@brief lib/cc: Macros for managing the C compiler and language.
|
@brief lib/cc: Macros for managing the C compiler and language.
|
||||||
**/
|
|
||||||
|
|
|
@ -1,8 +1,6 @@
|
||||||
/**
|
|
||||||
@dir /lib/compress
|
@dir /lib/compress
|
||||||
@brief lib/compress: Wraps several compression libraries
|
@brief lib/compress: Wraps several compression libraries
|
||||||
|
|
||||||
Currently supported are zlib (mandatory), zstd (optional), and lzma
|
Currently supported are zlib (mandatory), zstd (optional), and lzma
|
||||||
(optional).
|
(optional).
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,5 +1,3 @@
|
||||||
/**
|
|
||||||
@dir /lib/conf
|
@dir /lib/conf
|
||||||
@brief lib/conf: Types and macros for declaring configuration options.
|
@brief lib/conf: Types and macros for declaring configuration options.
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
/**
|
|
||||||
@dir /lib/confmgt
|
@dir /lib/confmgt
|
||||||
@brief lib/confmgt: Parse, encode, manipulate configuration files.
|
@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,
|
configuration files (config.c) to manage a set of named, typed fields,
|
||||||
reading and writing them to disk and to the controller.
|
reading and writing them to disk and to the controller.
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
/**
|
|
||||||
@dir /lib/container
|
@dir /lib/container
|
||||||
@brief lib/container: Hash tables, dynamic arrays, bit arrays, etc.
|
@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.
|
<!-- TODO: WRITE about bloom filters, namemaps, bit-arrays, order functions.
|
||||||
-->
|
-->
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
/**
|
|
||||||
|
|
||||||
@page certificates Certificates in Tor.
|
@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
|
consider these documents to be an additional kind of certificate if you
|
||||||
want.)
|
want.)
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
/**
|
|
||||||
@dir /lib/crypt_ops
|
@dir /lib/crypt_ops
|
||||||
@brief lib/crypt_ops: Cryptographic operations.
|
@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
|
and crypto_unpwbox functions do so in a way that's likely to be
|
||||||
readable by future versions of Tor.
|
readable by future versions of Tor.
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
/**
|
|
||||||
@dir /lib/ctime
|
@dir /lib/ctime
|
||||||
@brief lib/ctime: Constant-time code to avoid side-channels.
|
@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() /
|
doesn't need to be constant-time to use the fast_memeq() / fast_memneq() /
|
||||||
fast_memcmp() aliases instead.
|
fast_memcmp() aliases instead.
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,4 +1,2 @@
|
||||||
/**
|
|
||||||
@dir /lib/defs
|
@dir /lib/defs
|
||||||
@brief lib/defs: Lowest-level constants, used in many places.
|
@brief lib/defs: Lowest-level constants, used in many places.
|
||||||
**/
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
/**
|
|
||||||
@dir /lib/dispatch
|
@dir /lib/dispatch
|
||||||
@brief lib/dispatch: In-process message delivery.
|
@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
|
to from more sophisticated architectures: this dispatcher is intended only
|
||||||
for use in improving Tor's architecture.
|
for use in improving Tor's architecture.
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,8 +1,6 @@
|
||||||
/**
|
|
||||||
@dir /lib/encoding
|
@dir /lib/encoding
|
||||||
@brief lib/encoding: Encoding data in various forms, types, and transformations
|
@brief lib/encoding: Encoding data in various forms, types, and transformations
|
||||||
|
|
||||||
Here we have time formats (timefmt.c), quoted strings (qstring.c), C strings
|
Here we have time formats (timefmt.c), quoted strings (qstring.c), C strings
|
||||||
(string.c) base-16/32/64 (binascii.c), and more.
|
(string.c) base-16/32/64 (binascii.c), and more.
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
/**
|
|
||||||
@dir /lib/err
|
@dir /lib/err
|
||||||
@brief lib/err: Lowest-level error handling code.
|
@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.
|
* Code that needs signal-safe error reporting.
|
||||||
* Higher-level error handling code.
|
* Higher-level error handling code.
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
/**
|
|
||||||
@dir /lib/evloop
|
@dir /lib/evloop
|
||||||
@brief lib/evloop: Low-level event loop.
|
@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
|
loop and related functionality, in order to implement asynchronous
|
||||||
networking, timers, periodic events, and other scheduling tasks.
|
networking, timers, periodic events, and other scheduling tasks.
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
/**
|
|
||||||
|
|
||||||
@page time_periodic Time and periodic events in Tor
|
@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
|
implementation as its backend, which is based on a hierarchical timing
|
||||||
wheel algorithm. It's cool stuff; check it out.)
|
wheel algorithm. It's cool stuff; check it out.)
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,7 +1,5 @@
|
||||||
/**
|
|
||||||
@dir /lib/fdio
|
@dir /lib/fdio
|
||||||
@brief lib/fdio: Code to read/write on file descriptors.
|
@brief lib/fdio: Code to read/write on file descriptors.
|
||||||
|
|
||||||
(This module also handles sockets, on platforms where a socket is not a kind
|
(This module also handles sockets, on platforms where a socket is not a kind
|
||||||
of fd.)
|
of fd.)
|
||||||
**/
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
/**
|
|
||||||
@dir /lib/fs
|
@dir /lib/fs
|
||||||
@brief lib/fs: Files, filenames, directories, etc.
|
@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,
|
It also contains a set of convenience functions for safely writing to files,
|
||||||
creating directories, and so on.
|
creating directories, and so on.
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,5 +1,3 @@
|
||||||
/**
|
|
||||||
@dir /lib/geoip
|
@dir /lib/geoip
|
||||||
@brief lib/geoip: IP-to-country mapping
|
@brief lib/geoip: IP-to-country mapping
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,4 +1,2 @@
|
||||||
/**
|
|
||||||
@dir /lib/intmath
|
@dir /lib/intmath
|
||||||
@brief lib/intmath: Integer mathematics.
|
@brief lib/intmath: Integer mathematics.
|
||||||
**/
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
/**
|
|
||||||
@dir /lib
|
@dir /lib
|
||||||
@brief lib: low-level functionality.
|
@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
|
issues among platforms, you should probably consider whether you can
|
||||||
put your code into lib.
|
put your code into lib.
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,8 +1,6 @@
|
||||||
/**
|
|
||||||
@dir /lib/lock
|
@dir /lib/lock
|
||||||
@brief lib/lock: Simple locking support.
|
@brief lib/lock: Simple locking support.
|
||||||
|
|
||||||
This module is more low-level than the rest of the threading code, since it
|
This module is more low-level than the rest of the threading code, since it
|
||||||
is needed by more intermediate-level modules.
|
is needed by more intermediate-level modules.
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
/**
|
|
||||||
@dir /lib/log
|
@dir /lib/log
|
||||||
@brief lib/log: Log messages to files, syslogs, etc.
|
@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.
|
depends on it.
|
||||||
|
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
/**
|
|
||||||
@dir /lib/malloc
|
@dir /lib/malloc
|
||||||
@brief lib/malloc: Wrappers and utilities for memory management.
|
@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))
|
#define x_free(ptr) FREE_AND_NULL(x_t, x_free_, (ptr))
|
||||||
```
|
```
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,8 +1,6 @@
|
||||||
/**
|
|
||||||
@dir /lib/math
|
@dir /lib/math
|
||||||
@brief lib/math: Floating-point math utilities.
|
@brief lib/math: Floating-point math utilities.
|
||||||
|
|
||||||
This module includes a bunch of floating-point compatibility code, and
|
This module includes a bunch of floating-point compatibility code, and
|
||||||
implementations for several probability distributions.
|
implementations for several probability distributions.
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
/**
|
|
||||||
@dir /lib/memarea
|
@dir /lib/memarea
|
||||||
@brief lib/memarea: A fast arena-style allocator.
|
@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
|
to the similarly-named malloc() functions. There is intentionally no
|
||||||
`memarea_free()` or `memarea_realloc()`.
|
`memarea_free()` or `memarea_realloc()`.
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,7 +1,5 @@
|
||||||
/**
|
|
||||||
@dir /lib/meminfo
|
@dir /lib/meminfo
|
||||||
@brief lib/meminfo: Inspecting malloc() usage.
|
@brief lib/meminfo: Inspecting malloc() usage.
|
||||||
|
|
||||||
Only available when malloc() provides mallinfo() or something similar.
|
Only available when malloc() provides mallinfo() or something similar.
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,8 +1,6 @@
|
||||||
/**
|
|
||||||
@dir /lib/net
|
@dir /lib/net
|
||||||
@brief lib/net: Low-level network-related code.
|
@brief lib/net: Low-level network-related code.
|
||||||
|
|
||||||
This module includes address manipulation, compatibility wrappers,
|
This module includes address manipulation, compatibility wrappers,
|
||||||
convenience functions, and so on.
|
convenience functions, and so on.
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
/**
|
|
||||||
@dir /lib/osinfo
|
@dir /lib/osinfo
|
||||||
@brief lib/osinfo: For inspecting the OS version and capabilities.
|
@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
|
these checks: instead, we should have more specific checks, either at compile
|
||||||
time or run time, based on the observed system behavior.
|
time or run time, based on the observed system behavior.
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,4 +1,2 @@
|
||||||
/**
|
|
||||||
@dir /lib/process
|
@dir /lib/process
|
||||||
@brief lib/process: Launch and manage subprocesses.
|
@brief lib/process: Launch and manage subprocesses.
|
||||||
**/
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
/**
|
|
||||||
@dir /lib/pubsub
|
@dir /lib/pubsub
|
||||||
@brief lib/pubsub: Publish-subscribe message passing.
|
@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.
|
See pubsub.c for more information.
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
/**
|
|
||||||
@dir /lib/sandbox
|
@dir /lib/sandbox
|
||||||
@brief lib/sandbox: Linux seccomp2-based 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
|
calls (like open()) in another, less restricted process, and give that
|
||||||
process responsibility for enforcing our sandbox rules.
|
process responsibility for enforcing our sandbox rules.
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
/**
|
|
||||||
@dir /lib/smartlist_core
|
@dir /lib/smartlist_core
|
||||||
@brief lib/smartlist_core: Minimal dynamic array implementation
|
@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
|
the ones in lib/smartlist_core are used by the logging code, and therefore
|
||||||
cannot use the logging code.
|
cannot use the logging code.
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
/**
|
|
||||||
@dir /lib/string
|
@dir /lib/string
|
||||||
@brief lib/string: Low-level string manipulation.
|
@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
|
Any string function high-level enough to need logging belongs in a
|
||||||
higher-level module.
|
higher-level module.
|
||||||
**/
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
/**
|
|
||||||
|
|
||||||
@page strings String processing in Tor
|
@page strings String processing in Tor
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
/**
|
|
||||||
|
|
||||||
@page initialization Initialization and shutdown
|
@page initialization Initialization and shutdown
|
||||||
|
|
||||||
|
@ -74,4 +73,3 @@ must occur _after_ the initialization process, during configuration.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
/**
|
|
||||||
@dir /lib/subsys
|
@dir /lib/subsys
|
||||||
@brief lib/subsys: Types for declaring a "subsystem".
|
@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
|
these to subsystems over time; please don't add any new code that follows
|
||||||
this pattern.
|
this pattern.
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,4 +1,2 @@
|
||||||
/**
|
|
||||||
@dir /lib/term
|
@dir /lib/term
|
||||||
@brief lib/term: Terminal operations (password input).
|
@brief lib/term: Terminal operations (password input).
|
||||||
**/
|
|
||||||
|
|
|
@ -1,4 +1,2 @@
|
||||||
/**
|
|
||||||
@dir /lib/testsupport
|
@dir /lib/testsupport
|
||||||
@brief lib/testsupport: Helpers for test-only code and for function mocking.
|
@brief lib/testsupport: Helpers for test-only code and for function mocking.
|
||||||
**/
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
/**
|
|
||||||
@dir /lib/thread
|
@dir /lib/thread
|
||||||
@brief lib/thread: Mid-level threading.
|
@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
|
except for low-level locks (which are in \refdir{lib/lock} and
|
||||||
workqueue/threadpool code (which belongs in \refdir{lib/evloop}.)
|
workqueue/threadpool code (which belongs in \refdir{lib/evloop}.)
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
/**
|
|
||||||
|
|
||||||
@page threading Threading in Tor
|
@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
|
make the worker "own" all the data it needs while the work is in
|
||||||
progress, and to give up ownership when it's complete.
|
progress, and to give up ownership when it's complete.
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
/**
|
|
||||||
@dir /lib/time
|
@dir /lib/time
|
||||||
@brief lib/time: Higher-level time functions
|
@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
|
For "what time is it" in UTC, see \refdir{lib/wallclock}. For parsing and
|
||||||
encoding times and dates, see \refdir{lib/encoding}.
|
encoding times and dates, see \refdir{lib/encoding}.
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
/**
|
|
||||||
@dir /lib/tls
|
@dir /lib/tls
|
||||||
@brief lib/tls: TLS library wrappers
|
@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
|
support in old versions of Tor, involving conditional delivery of certificate
|
||||||
chains (v1 link protocol) and conditional renegotiation (v2 link protocol).
|
chains (v1 link protocol) and conditional renegotiation (v2 link protocol).
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,8 +1,6 @@
|
||||||
/**
|
|
||||||
@dir /lib/trace
|
@dir /lib/trace
|
||||||
@brief lib/trace: Function-tracing functionality API.
|
@brief lib/trace: Function-tracing functionality API.
|
||||||
|
|
||||||
This module is used for adding "trace" support (low-granularity function
|
This module is used for adding "trace" support (low-granularity function
|
||||||
logging) to Tor. Right now it doesn't have many users.
|
logging) to Tor. Right now it doesn't have many users.
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,4 +1,2 @@
|
||||||
/**
|
|
||||||
@dir /lib/version
|
@dir /lib/version
|
||||||
@brief lib/version: holds the current version of Tor.
|
@brief lib/version: holds the current version of Tor.
|
||||||
**/
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
/**
|
|
||||||
@dir /lib/wallclock
|
@dir /lib/wallclock
|
||||||
@brief lib/wallclock: Inspect and manipulate the current time.
|
@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,
|
accurate, see \refdir{lib/time}. For parsing and encoding times and dates,
|
||||||
see \refdir{lib/encoding}.
|
see \refdir{lib/encoding}.
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
/**
|
|
||||||
@mainpage Tor source reference
|
@mainpage Tor source reference
|
||||||
|
|
||||||
@tableofcontents
|
@tableofcontents
|
||||||
|
@ -42,9 +41,7 @@ Tor repository.
|
||||||
|
|
||||||
@subpage time_periodic
|
@subpage time_periodic
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
||||||
/**
|
|
||||||
@page intro A high-level overview
|
@page intro A high-level overview
|
||||||
|
|
||||||
@tableofcontents
|
@tableofcontents
|
||||||
|
@ -144,4 +141,3 @@ more connection types.
|
||||||
A 'Node' (node_t) is a view of a Tor instance's current knowledge and opinions
|
A 'Node' (node_t) is a view of a Tor instance's current knowledge and opinions
|
||||||
about a Tor relay or bridge.
|
about a Tor relay or bridge.
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
|
@ -1,8 +1,6 @@
|
||||||
/**
|
|
||||||
@dir /tools
|
@dir /tools
|
||||||
@brief tools: other command-line tools for use with Tor.
|
@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
|
The "tools" directory has a few other programs that use Tor, but are not part
|
||||||
of the main Tor binary.
|
of the main Tor binary.
|
||||||
|
|
||||||
**/
|
|
||||||
|
|
Loading…
Add table
Reference in a new issue