Document our top-level directories

This commit is contained in:
Nick Mathewson 2019-11-04 07:40:20 -05:00
parent 7fc077ed25
commit d3af23783c
5 changed files with 26 additions and 5 deletions

View File

@ -1,4 +1,8 @@
/**
@dir app
@brief 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.
**/

View File

@ -1,4 +1,8 @@
/**
@dir core
@brief core
@brief core: main loop and onion routing functionality
The "core" directory has the central protocols for Tor, which every
client and relay must implement in order to perform onion routing.
**/

View File

@ -1,4 +1,9 @@
/**
@dir feature
@brief feature
@brief feature: domain-specific modules
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.
**/

View File

@ -1,4 +1,8 @@
/**
@dir lib
@brief lib
@brief lib: low-level functionality.
The "lib" directory contains low-level functionality, most of it not
necessarily Tor-specific.
**/

View File

@ -1,4 +1,8 @@
/**
@dir tools
@brief 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.
**/