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:
Nick Mathewson 2019-11-04 10:23:36 -05:00
parent 51a9892914
commit 62a473debf
66 changed files with 66 additions and 66 deletions

View File

@ -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,

View File

@ -1,4 +1,4 @@
/** /**
@dir app/config @dir /app/config
@brief app/config @brief app/config
**/ **/

View File

@ -1,4 +1,4 @@
/** /**
@dir app/main @dir /app/main
@brief app/main @brief app/main
**/ **/

View File

@ -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

View File

@ -1,4 +1,4 @@
/** /**
@dir core/crypto @dir /core/crypto
@brief core/crypto @brief core/crypto
**/ **/

View File

@ -1,4 +1,4 @@
/** /**
@dir core/mainloop @dir /core/mainloop
@brief core/mainloop @brief core/mainloop
**/ **/

View File

@ -1,4 +1,4 @@
/** /**
@dir core/or @dir /core/or
@brief core/or @brief core/or
**/ **/

View File

@ -1,4 +1,4 @@
/** /**
@dir core/proto @dir /core/proto
@brief core/proto @brief core/proto
**/ **/

View File

@ -1,4 +1,4 @@
/** /**
@dir feature/api @dir /feature/api
@brief feature/api @brief feature/api
**/ **/

View File

@ -1,4 +1,4 @@
/** /**
@dir feature/client @dir /feature/client
@brief feature/client @brief feature/client
**/ **/

View File

@ -1,4 +1,4 @@
/** /**
@dir feature/control @dir /feature/control
@brief feature/control @brief feature/control
**/ **/

View File

@ -1,4 +1,4 @@
/** /**
@dir feature/dirauth @dir /feature/dirauth
@brief feature/dirauth @brief feature/dirauth
**/ **/

View File

@ -1,4 +1,4 @@
/** /**
@dir feature/dircache @dir /feature/dircache
@brief feature/dircache @brief feature/dircache
**/ **/

View File

@ -1,4 +1,4 @@
/** /**
@dir feature/dirclient @dir /feature/dirclient
@brief feature/dirclient @brief feature/dirclient
**/ **/

View File

@ -1,4 +1,4 @@
/** /**
@dir feature/dircommon @dir /feature/dircommon
@brief feature/dircommon @brief feature/dircommon
**/ **/

View File

@ -1,4 +1,4 @@
/** /**
@dir feature/dirparse @dir /feature/dirparse
@brief feature/dirparse @brief feature/dirparse
**/ **/

View File

@ -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

View File

@ -1,4 +1,4 @@
/** /**
@dir feature/hibernate @dir /feature/hibernate
@brief feature/hibernate @brief feature/hibernate
**/ **/

View File

@ -1,4 +1,4 @@
/** /**
@dir feature/hs @dir /feature/hs
@brief feature/hs @brief feature/hs
**/ **/

View File

@ -1,4 +1,4 @@
/** /**
@dir feature/hs_common @dir /feature/hs_common
@brief feature/hs_common @brief feature/hs_common
**/ **/

View File

@ -1,4 +1,4 @@
/** /**
@dir feature/keymgt @dir /feature/keymgt
@brief feature/keymgt @brief feature/keymgt
**/ **/

View File

@ -1,4 +1,4 @@
/** /**
@dir feature/nodelist @dir /feature/nodelist
@brief feature/nodelist @brief feature/nodelist
**/ **/

View File

@ -1,4 +1,4 @@
/** /**
@dir feature/relay @dir /feature/relay
@brief feature/relay @brief feature/relay
**/ **/

View File

@ -1,4 +1,4 @@
/** /**
@dir feature/rend @dir /feature/rend
@brief feature/rend @brief feature/rend
**/ **/

View File

@ -1,4 +1,4 @@
/** /**
@dir feature/stats @dir /feature/stats
@brief feature/stats @brief feature/stats
**/ **/

View File

@ -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.
**/ **/

View File

@ -1,4 +1,4 @@
/** /**
@dir lib/buf @dir /lib/buf
@brief lib/buf @brief lib/buf
**/ **/

View File

@ -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.
**/ **/

View File

@ -1,4 +1,4 @@
/** /**
@dir lib/compress @dir /lib/compress
@brief lib/compress @brief lib/compress
**/ **/

View File

@ -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.
**/ **/

View File

@ -1,4 +1,4 @@
/** /**
@dir lib/confmgt @dir /lib/confmgt
@brief lib/confmgt @brief lib/confmgt
**/ **/

View File

@ -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.
**/ **/

View File

@ -1,4 +1,4 @@
/** /**
@dir lib/crypt_ops @dir /lib/crypt_ops
@brief lib/crypt_ops @brief lib/crypt_ops
**/ **/

View File

@ -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

View File

@ -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.
**/ **/

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -1,4 +1,4 @@
/** /**
@dir lib/evloop @dir /lib/evloop
@brief lib/evloop @brief lib/evloop
**/ **/

View File

@ -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

View File

@ -1,4 +1,4 @@
/** /**
@dir lib/fs @dir /lib/fs
@brief lib/fs @brief lib/fs
**/ **/

View File

@ -1,4 +1,4 @@
/** /**
@dir lib/geoip @dir /lib/geoip
@brief lib/geoip @brief lib/geoip
**/ **/

View File

@ -1,4 +1,4 @@
/** /**
@dir lib/intmath @dir /lib/intmath
@brief lib/intmath Integer mathematics. @brief lib/intmath Integer mathematics.
**/ **/

View File

@ -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

View File

@ -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

View File

@ -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.
**/ **/

View File

@ -1,4 +1,4 @@
/** /**
@dir lib/math @dir /lib/math
@brief lib/math @brief lib/math
**/ **/

View File

@ -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

View File

@ -1,4 +1,4 @@
/** /**
@dir lib/meminfo @dir /lib/meminfo
@brief lib/meminfo @brief lib/meminfo
**/ **/

View File

@ -1,4 +1,4 @@
/** /**
@dir lib/net @dir /lib/net
@brief lib/net @brief lib/net
**/ **/

View File

@ -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

View File

@ -1,4 +1,4 @@
/** /**
@dir lib/process @dir /lib/process
@brief lib/process @brief lib/process
**/ **/

View File

@ -1,4 +1,4 @@
/** /**
@dir lib/pubsub @dir /lib/pubsub
@brief lib/pubsub @brief lib/pubsub
**/ **/

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -1,4 +1,4 @@
/** /**
@dir lib/term @dir /lib/term
@brief lib/term @brief lib/term
**/ **/

View File

@ -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.
**/ **/

View File

@ -1,4 +1,4 @@
/** /**
@dir lib/thread @dir /lib/thread
@brief lib/thread @brief lib/thread
**/ **/

View File

@ -1,4 +1,4 @@
/** /**
@dir lib/time @dir /lib/time
@brief lib/time @brief lib/time
**/ **/

View File

@ -1,4 +1,4 @@
/** /**
@dir lib/tls @dir /lib/tls
@brief lib/tls @brief lib/tls
**/ **/

View File

@ -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

View File

@ -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.
**/ **/

View File

@ -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

View File

@ -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