[tor-commits] [tor/master] Document ADDRMAPSRC_NONE.

[nickm at torproject.org]

commit c18b6ec3d40593ff411809acac972a51ab451d52
Author: Nick Mathewson <nickm at torproject.org>
Date:   Mon Jun 11 21:49:08 2012 -0400

    Document ADDRMAPSRC_NONE.
---
 src/or/or.h |    4 +++-
 1 files changed, 3 insertions(+), 1 deletions(-)

diff --git a/src/or/or.h b/src/or/or.h
index f1260d1..b77f4c6 100644
--- a/src/or/or.h
+++ b/src/or/or.h
@@ -3857,7 +3857,9 @@ typedef enum {
    * Tor server that told us what its value was. */
   ADDRMAPSRC_DNS,
 
-  /** DOCDOC */
+  /** No remapping has occurred.  This isn't a possible value for an
+   * addrmap_entry_t; it's used as a null value when we need to answer "Why
+   * did this remapping happen." */
   ADDRMAPSRC_NONE
 } addressmap_entry_source_t;