[or-cvs] r8637: More doxygen comments (in tor/trunk: . src/common src/or)

[nickm at seul.org]

Author: nickm
Date: 2006-10-07 12:25:28 -0400 (Sat, 07 Oct 2006)
New Revision: 8637

Modified:
   tor/trunk/
   tor/trunk/src/common/tortls.c
   tor/trunk/src/common/util.c
   tor/trunk/src/or/or.h
Log:
 r8923 at totoro:  nickm | 2006-10-07 11:44:33 -0400
 More doxygen comments



Property changes on: tor/trunk
___________________________________________________________________
 svk:merge ticket from /tor/trunk [r8923] on 96637b51-b116-0410-a10e-9941ebb49b64

Modified: tor/trunk/src/common/tortls.c
===================================================================
--- tor/trunk/src/common/tortls.c	2006-10-07 16:25:15 UTC (rev 8636)
+++ tor/trunk/src/common/tortls.c	2006-10-07 16:25:28 UTC (rev 8637)
@@ -37,7 +37,7 @@
 /** How long do identity certificates live? (sec) */
 #define IDENTITY_CERT_LIFETIME  (365*24*60*60)
 
-/* DOCDOC */
+/** Structure holding the TLS state for a single connection. */
 typedef struct tor_tls_context_t {
   SSL_CTX *ctx;
 } tor_tls_context_t;

Modified: tor/trunk/src/common/util.c
===================================================================
--- tor/trunk/src/common/util.c	2006-10-07 16:25:15 UTC (rev 8636)
+++ tor/trunk/src/common/util.c	2006-10-07 16:25:28 UTC (rev 8637)
@@ -926,10 +926,10 @@
   return 0;
 }
 
-/** Set <b>buf</b> to the ISO???? encoding of the local value of <b>t</b>.
+/** Set <b>buf</b> to the ISO8601 encoding of the local value of <b>t</b>.
  * The buffer must be at least ISO_TIME_LEN+1 bytes long.
  *
- * (ISO???? format is 2006-10-29 10:57:20)
+ * (ISO8601 format is 2006-10-29 10:57:20)
  */
 void
 format_local_iso_time(char *buf, time_t t)
@@ -938,7 +938,7 @@
   strftime(buf, ISO_TIME_LEN+1, "%Y-%m-%d %H:%M:%S", tor_localtime_r(&t, &tm));
 }
 
-/** Set <b>buf</b> to the ISO???? encoding of the GMT value of <b>t</b>.
+/** Set <b>buf</b> to the ISO8601 encoding of the GMT value of <b>t</b>.
  * The buffer must be at least ISO_TIME_LEN+1 bytes long.
  */
 void

Modified: tor/trunk/src/or/or.h
===================================================================
--- tor/trunk/src/or/or.h	2006-10-07 16:25:15 UTC (rev 8636)
+++ tor/trunk/src/or/or.h	2006-10-07 16:25:28 UTC (rev 8637)
@@ -1048,7 +1048,9 @@
   /** List of signed_descriptor_t for older router descriptors we're
    * caching. */
   smartlist_t *old_routers;
-  /** DOCDOC */
+  /** Mmaped file holding server descriptors.  If present, any router whose
+   * cache_info.saved_location == SAVED_IN_CACHE is stored in this file
+   * starting at cache_info.saved_offset */
   tor_mmap_t *mmap_descriptors;
 } routerlist_t;