[or-cvs] r9998: Document some fields in or.h (in tor/trunk: . src/or)

[nickm at seul.org]

Author: nickm
Date: 2007-04-21 13:46:22 -0400 (Sat, 21 Apr 2007)
New Revision: 9998

Modified:
   tor/trunk/
   tor/trunk/src/or/or.h
Log:
 r12485 at catbus:  nickm | 2007-04-21 13:46:14 -0400
 Document some fields in or.h



Property changes on: tor/trunk
___________________________________________________________________
 svk:merge ticket from /tor/trunk [r12485] on 8246c3cf-6607-4228-993b-4d95d33730f1

Modified: tor/trunk/src/or/or.h
===================================================================
--- tor/trunk/src/or/or.h	2007-04-21 17:46:17 UTC (rev 9997)
+++ tor/trunk/src/or/or.h	2007-04-21 17:46:22 UTC (rev 9998)
@@ -801,9 +801,14 @@
   struct connection_t *linked_conn;
   /* XXXX020 NM move these up to the other 1-bit flags. */
   unsigned int linked:1; /**< True if there is, or has been, a linked_conn. */
-  unsigned int reading_from_linked_conn:1; /**DOCDOC*/
-  unsigned int writing_to_linked_conn:1; /**DOCDOC*/
-  unsigned int active_on_link:1; /**DOCDOC*/
+  /** True iff we'd like to be notified about read events from the linked conn.
+   */
+  unsigned int reading_from_linked_conn:1;
+  /** True iff we're willing  to write to the linked conn. */
+  unsigned int writing_to_linked_conn:1;
+  /** True iff we're currently able to read on the linked conn, and our
+   * read_event should be made active with libevent. */
+  unsigned int active_on_link:1;
 
 } connection_t;
 
@@ -1132,11 +1137,16 @@
   int routerlist_index;
 } routerinfo_t;
 
-/** DOCDOC */
+/** Information needed to keep and cache a signed extra-info document. */
 typedef struct extrainfo_t {
   signed_descriptor_t cache_info;
+  /** The router's nickname. */
   char nickname[MAX_NICKNAME_LEN+1];
+  /** True iff we found the right key for this extra-info, verified the
+   * signature, and found it to be bad. */
   unsigned int bad_sig : 1;
+  /** If present, we didn't have the right key to verify this extra-info,
+   * so this is a copy of the signature in the document. */
   char *pending_sig;
 } extrainfo_t;