]> git.ipfire.org Git - thirdparty/tor.git/commit
Write a bunch of module documentation.
authorNick Mathewson <nickm@torproject.org>
Sat, 15 Oct 2016 00:08:51 +0000 (20:08 -0400)
committerNick Mathewson <nickm@torproject.org>
Mon, 17 Oct 2016 14:16:59 +0000 (10:16 -0400)
commitaae034d13e458dfe82b503d3a1b54b0e5200b6b8
treef2f69832a97045fbe2384e7320c73d3ea7c86ba8
parent55c468c5211d5b74acb677767f14d91cd0304771
Write a bunch of module documentation.

This commit adds or improves the module-level documenation for:

  buffers.c circuitstats.c command.c connection_edge.c control.c
  cpuworker.c crypto_curve25519.c crypto_curve25519.h
  crypto_ed25519.c crypto_format.c dircollate.c dirserv.c dns.c
  dns_structs.h fp_pair.c geoip.c hibernate.c keypin.c ntmain.c
  onion.c onion_fast.c onion_ntor.c onion_tap.c periodic.c
  protover.c protover.h reasons.c rephist.c replaycache.c
  routerlist.c routerparse.c routerset.c statefile.c status.c
  tor_main.c workqueue.c

In particular, I've tried to explain (for each documented module)
what each module does, what's in it, what the big idea is, why it
belongs in Tor, and who calls it.  In a few cases, I've added TODO
notes about refactoring opportunities.

I've also renamed an argument, and fixed a few DOCDOC comments.
36 files changed:
src/common/crypto_curve25519.c
src/common/crypto_curve25519.h
src/common/crypto_ed25519.c
src/common/crypto_format.c
src/common/workqueue.c
src/or/buffers.c
src/or/circuitstats.c
src/or/command.c
src/or/connection_edge.c
src/or/control.c
src/or/cpuworker.c
src/or/dircollate.c
src/or/dirserv.c
src/or/dns.c
src/or/dns_structs.h
src/or/fp_pair.c
src/or/geoip.c
src/or/hibernate.c
src/or/keypin.c
src/or/ntmain.c
src/or/onion.c
src/or/onion_fast.c
src/or/onion_ntor.c
src/or/onion_tap.c
src/or/periodic.c
src/or/protover.c
src/or/protover.h
src/or/reasons.c
src/or/rephist.c
src/or/replaycache.c
src/or/routerlist.c
src/or/routerparse.c
src/or/routerset.c
src/or/statefile.c
src/or/status.c
src/or/tor_main.c