[or-cvs] r10789: clean up a comment (tor/trunk/src/or)

[arma at seul.org]

Author: arma
Date: 2007-07-10 23:28:12 -0400 (Tue, 10 Jul 2007)
New Revision: 10789

Modified:
   tor/trunk/src/or/or.h
Log:
clean up a comment


Modified: tor/trunk/src/or/or.h
===================================================================
--- tor/trunk/src/or/or.h	2007-07-10 22:44:32 UTC (rev 10788)
+++ tor/trunk/src/or/or.h	2007-07-11 03:28:12 UTC (rev 10789)
@@ -589,9 +589,9 @@
 #define END_CIRC_REASON_NOSUCHSERVICE   12
 #define _END_CIRC_REASON_MAX            12
 
-/* OR this with the argument to circuit_mark_for_close, or
- * control_event_circuit_status to indicate that the reason came from a
- * destroy or truncate cell. */
+/** Bitwise-OR this with the argument to circuit_mark_for_close() or
+ * control_event_circuit_status() to indicate that the reason was
+ * passed through from a destroy or truncate cell. */
 #define END_CIRC_REASON_FLAG_REMOTE     512
 
 /** Length of 'y' portion of 'y.onion' URL. */