mirror of
https://gitlab.torproject.org/tpo/core/tor.git
synced 2024-11-11 05:33:47 +01:00
Doxygen: Avoid ambiguity in @dir directives
This commit was automatically generated with: find src -name '*.dox' |xargs perl -i -pe 's{\@dir ([^/])}{\@dir /$1};'
This commit is contained in:
parent
51a9892914
commit
62a473debf
@ -1,5 +1,5 @@
|
|||||||
/**
|
/**
|
||||||
@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,
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
/**
|
/**
|
||||||
@dir app/config
|
@dir /app/config
|
||||||
@brief app/config
|
@brief app/config
|
||||||
**/
|
**/
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
/**
|
/**
|
||||||
@dir app/main
|
@dir /app/main
|
||||||
@brief app/main
|
@brief app/main
|
||||||
**/
|
**/
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
/**
|
/**
|
||||||
@dir core
|
@dir /core
|
||||||
@brief core: main loop and onion routing functionality
|
@brief core: main loop and onion routing functionality
|
||||||
|
|
||||||
The "core" directory has the central protocols for Tor, which every
|
The "core" directory has the central protocols for Tor, which every
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
/**
|
/**
|
||||||
@dir core/crypto
|
@dir /core/crypto
|
||||||
@brief core/crypto
|
@brief core/crypto
|
||||||
**/
|
**/
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
/**
|
/**
|
||||||
@dir core/mainloop
|
@dir /core/mainloop
|
||||||
@brief core/mainloop
|
@brief core/mainloop
|
||||||
**/
|
**/
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
/**
|
/**
|
||||||
@dir core/or
|
@dir /core/or
|
||||||
@brief core/or
|
@brief core/or
|
||||||
**/
|
**/
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
/**
|
/**
|
||||||
@dir core/proto
|
@dir /core/proto
|
||||||
@brief core/proto
|
@brief core/proto
|
||||||
**/
|
**/
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
/**
|
/**
|
||||||
@dir feature/api
|
@dir /feature/api
|
||||||
@brief feature/api
|
@brief feature/api
|
||||||
**/
|
**/
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
/**
|
/**
|
||||||
@dir feature/client
|
@dir /feature/client
|
||||||
@brief feature/client
|
@brief feature/client
|
||||||
**/
|
**/
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
/**
|
/**
|
||||||
@dir feature/control
|
@dir /feature/control
|
||||||
@brief feature/control
|
@brief feature/control
|
||||||
**/
|
**/
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
/**
|
/**
|
||||||
@dir feature/dirauth
|
@dir /feature/dirauth
|
||||||
@brief feature/dirauth
|
@brief feature/dirauth
|
||||||
**/
|
**/
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
/**
|
/**
|
||||||
@dir feature/dircache
|
@dir /feature/dircache
|
||||||
@brief feature/dircache
|
@brief feature/dircache
|
||||||
**/
|
**/
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
/**
|
/**
|
||||||
@dir feature/dirclient
|
@dir /feature/dirclient
|
||||||
@brief feature/dirclient
|
@brief feature/dirclient
|
||||||
**/
|
**/
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
/**
|
/**
|
||||||
@dir feature/dircommon
|
@dir /feature/dircommon
|
||||||
@brief feature/dircommon
|
@brief feature/dircommon
|
||||||
**/
|
**/
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
/**
|
/**
|
||||||
@dir feature/dirparse
|
@dir /feature/dirparse
|
||||||
@brief feature/dirparse
|
@brief feature/dirparse
|
||||||
**/
|
**/
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
/**
|
/**
|
||||||
@dir feature
|
@dir /feature
|
||||||
@brief feature: domain-specific modules
|
@brief feature: domain-specific modules
|
||||||
|
|
||||||
The "feature" directory has modules that Tor uses only for a particular
|
The "feature" directory has modules that Tor uses only for a particular
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
/**
|
/**
|
||||||
@dir feature/hibernate
|
@dir /feature/hibernate
|
||||||
@brief feature/hibernate
|
@brief feature/hibernate
|
||||||
**/
|
**/
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
/**
|
/**
|
||||||
@dir feature/hs
|
@dir /feature/hs
|
||||||
@brief feature/hs
|
@brief feature/hs
|
||||||
**/
|
**/
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
/**
|
/**
|
||||||
@dir feature/hs_common
|
@dir /feature/hs_common
|
||||||
@brief feature/hs_common
|
@brief feature/hs_common
|
||||||
**/
|
**/
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
/**
|
/**
|
||||||
@dir feature/keymgt
|
@dir /feature/keymgt
|
||||||
@brief feature/keymgt
|
@brief feature/keymgt
|
||||||
**/
|
**/
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
/**
|
/**
|
||||||
@dir feature/nodelist
|
@dir /feature/nodelist
|
||||||
@brief feature/nodelist
|
@brief feature/nodelist
|
||||||
**/
|
**/
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
/**
|
/**
|
||||||
@dir feature/relay
|
@dir /feature/relay
|
||||||
@brief feature/relay
|
@brief feature/relay
|
||||||
**/
|
**/
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
/**
|
/**
|
||||||
@dir feature/rend
|
@dir /feature/rend
|
||||||
@brief feature/rend
|
@brief feature/rend
|
||||||
**/
|
**/
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
/**
|
/**
|
||||||
@dir feature/stats
|
@dir /feature/stats
|
||||||
@brief feature/stats
|
@brief feature/stats
|
||||||
**/
|
**/
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
/**
|
/**
|
||||||
@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,4 @@
|
|||||||
/**
|
/**
|
||||||
@dir lib/buf
|
@dir /lib/buf
|
||||||
@brief lib/buf
|
@brief lib/buf
|
||||||
**/
|
**/
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
/**
|
/**
|
||||||
@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,4 +1,4 @@
|
|||||||
/**
|
/**
|
||||||
@dir lib/compress
|
@dir /lib/compress
|
||||||
@brief lib/compress
|
@brief lib/compress
|
||||||
**/
|
**/
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
/**
|
/**
|
||||||
@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,4 @@
|
|||||||
/**
|
/**
|
||||||
@dir lib/confmgt
|
@dir /lib/confmgt
|
||||||
@brief lib/confmgt
|
@brief lib/confmgt
|
||||||
**/
|
**/
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
/**
|
/**
|
||||||
@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.
|
||||||
|
|
||||||
**/
|
**/
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
/**
|
/**
|
||||||
@dir lib/crypt_ops
|
@dir /lib/crypt_ops
|
||||||
@brief lib/crypt_ops
|
@brief lib/crypt_ops
|
||||||
**/
|
**/
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
/**
|
/**
|
||||||
@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.
|
||||||
|
|
||||||
This module contains constant-time implementations of various
|
This module contains constant-time implementations of various
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
/**
|
/**
|
||||||
@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,5 +1,5 @@
|
|||||||
/**
|
/**
|
||||||
@dir lib/dispatch
|
@dir /lib/dispatch
|
||||||
@brief lib/dispatch: In-process message delivery.
|
@brief lib/dispatch: In-process message delivery.
|
||||||
|
|
||||||
This module provides a general in-process "message dispatch" system in which
|
This module provides a general in-process "message dispatch" system in which
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
/**
|
/**
|
||||||
@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
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
/**
|
/**
|
||||||
@dir lib/err
|
@dir /lib/err
|
||||||
@brief lib/err: Lowest-level error handling code.
|
@brief lib/err: Lowest-level error handling code.
|
||||||
|
|
||||||
This module is responsible for generating stack traces, handling raw
|
This module is responsible for generating stack traces, handling raw
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
/**
|
/**
|
||||||
@dir lib/evloop
|
@dir /lib/evloop
|
||||||
@brief lib/evloop
|
@brief lib/evloop
|
||||||
**/
|
**/
|
||||||
|
@ -1,5 +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
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
/**
|
/**
|
||||||
@dir lib/fs
|
@dir /lib/fs
|
||||||
@brief lib/fs
|
@brief lib/fs
|
||||||
**/
|
**/
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
/**
|
/**
|
||||||
@dir lib/geoip
|
@dir /lib/geoip
|
||||||
@brief lib/geoip
|
@brief lib/geoip
|
||||||
**/
|
**/
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
/**
|
/**
|
||||||
@dir lib/intmath
|
@dir /lib/intmath
|
||||||
@brief lib/intmath Integer mathematics.
|
@brief lib/intmath Integer mathematics.
|
||||||
**/
|
**/
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
/**
|
/**
|
||||||
@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
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
/**
|
/**
|
||||||
@dir lib/log
|
@dir /lib/log
|
||||||
@brief lib/log: Log messages to files, syslogs, etc.
|
@brief lib/log: Log messages to files, syslogs, etc.
|
||||||
|
|
||||||
You can think of this as the logical "midpoint" of the
|
You can think of this as the logical "midpoint" of the
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
/**
|
/**
|
||||||
@dir lib/malloc
|
@dir /lib/malloc
|
||||||
@brief lib/malloc: Wrappers and utilities for memory management.
|
@brief lib/malloc: Wrappers and utilities for memory management.
|
||||||
|
|
||||||
**/
|
**/
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
/**
|
/**
|
||||||
@dir lib/math
|
@dir /lib/math
|
||||||
@brief lib/math
|
@brief lib/math
|
||||||
**/
|
**/
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
/**
|
/**
|
||||||
@dir lib/memarea
|
@dir /lib/memarea
|
||||||
@brief lib/memarea A fast arena-style allocator.
|
@brief lib/memarea A fast arena-style allocator.
|
||||||
|
|
||||||
This module has a fast "arena" style allocator, where memory is freed all at
|
This module has a fast "arena" style allocator, where memory is freed all at
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
/**
|
/**
|
||||||
@dir lib/meminfo
|
@dir /lib/meminfo
|
||||||
@brief lib/meminfo
|
@brief lib/meminfo
|
||||||
**/
|
**/
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
/**
|
/**
|
||||||
@dir lib/net
|
@dir /lib/net
|
||||||
@brief lib/net
|
@brief lib/net
|
||||||
**/
|
**/
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
/**
|
/**
|
||||||
@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.
|
||||||
|
|
||||||
In general, we use this module when we're telling the user what operating
|
In general, we use this module when we're telling the user what operating
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
/**
|
/**
|
||||||
@dir lib/process
|
@dir /lib/process
|
||||||
@brief lib/process
|
@brief lib/process
|
||||||
**/
|
**/
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
/**
|
/**
|
||||||
@dir lib/pubsub
|
@dir /lib/pubsub
|
||||||
@brief lib/pubsub
|
@brief lib/pubsub
|
||||||
**/
|
**/
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
/**
|
/**
|
||||||
@dir lib/sandbox
|
@dir /lib/sandbox
|
||||||
@brief lib/sandbox Linux seccomp2-based sandbox.
|
@brief lib/sandbox Linux seccomp2-based sandbox.
|
||||||
|
|
||||||
This module uses Linux's seccomp2 facility via the
|
This module uses Linux's seccomp2 facility via the
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
/**
|
/**
|
||||||
@dir lib/smartlist_core
|
@dir /lib/smartlist_core
|
||||||
@brief lib/smartlist_core: Minimal dynamic array implementation
|
@brief lib/smartlist_core: Minimal dynamic array implementation
|
||||||
|
|
||||||
A `smartlist_t` is a dynamic array type for holding `void *`. We use it
|
A `smartlist_t` is a dynamic array type for holding `void *`. We use it
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
/**
|
/**
|
||||||
@dir lib/string
|
@dir /lib/string
|
||||||
@brief lib/string: Low-level string manipulation.
|
@brief lib/string: Low-level string manipulation.
|
||||||
|
|
||||||
We have a number of compatibility functions here: some are for handling
|
We have a number of compatibility functions here: some are for handling
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
/**
|
/**
|
||||||
@dir lib/subsys
|
@dir /lib/subsys
|
||||||
@brief lib/subsys: Types for declaring a "subsystem".
|
@brief lib/subsys: Types for declaring a "subsystem".
|
||||||
|
|
||||||
## Subsystems in Tor
|
## Subsystems in Tor
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
/**
|
/**
|
||||||
@dir lib/term
|
@dir /lib/term
|
||||||
@brief lib/term
|
@brief lib/term
|
||||||
**/
|
**/
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
/**
|
/**
|
||||||
@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,4 @@
|
|||||||
/**
|
/**
|
||||||
@dir lib/thread
|
@dir /lib/thread
|
||||||
@brief lib/thread
|
@brief lib/thread
|
||||||
**/
|
**/
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
/**
|
/**
|
||||||
@dir lib/time
|
@dir /lib/time
|
||||||
@brief lib/time
|
@brief lib/time
|
||||||
**/
|
**/
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
/**
|
/**
|
||||||
@dir lib/tls
|
@dir /lib/tls
|
||||||
@brief lib/tls
|
@brief lib/tls
|
||||||
**/
|
**/
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
/**
|
/**
|
||||||
@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
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
/**
|
/**
|
||||||
@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,5 +1,5 @@
|
|||||||
/**
|
/**
|
||||||
@dir lib/wallclock
|
@dir /lib/wallclock
|
||||||
@brief lib/wallclock: Inspect and manipulate the current time.
|
@brief lib/wallclock: Inspect and manipulate the current time.
|
||||||
|
|
||||||
This module handles our concept of "what time is it" or "what time does the
|
This module handles our concept of "what time is it" or "what time does the
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
/**
|
/**
|
||||||
@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
|
||||||
|
Loading…
Reference in New Issue
Block a user