[or-cvs] doxygen markup for common/*.h

[Roger Dingledine]

Update of /home/or/cvsroot/src/common
In directory moria.mit.edu:/home2/arma/work/onion/cvs/src/common

Modified Files:
	aes.h crypto.h fakepoll.h log.h test.h torint.h tortls.h 
	util.h 
Log Message:
doxygen markup for common/*.h


Index: aes.h
===================================================================
RCS file: /home/or/cvsroot/src/common/aes.h,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -r1.4 -r1.5
--- aes.h	6 Apr 2004 03:44:35 -0000	1.4
+++ aes.h	10 May 2004 07:54:13 -0000	1.5
@@ -7,6 +7,11 @@
 #ifndef __AES_H
 #define __AES_H
 
+/**
+ * \file aes.h
+ * \brief Headers for aes.c
+ */
+
 #include "../common/torint.h"
 
 struct aes_cnt_cipher;

Index: crypto.h
===================================================================
RCS file: /home/or/cvsroot/src/common/crypto.h,v
retrieving revision 1.46
retrieving revision 1.47
diff -u -d -r1.46 -r1.47
--- crypto.h	10 May 2004 03:53:24 -0000	1.46
+++ crypto.h	10 May 2004 07:54:13 -0000	1.47
@@ -3,7 +3,7 @@
 /* $Id$ */
 
 /**
- * \file crypto.c
+ * \file crypto.h
  *
  * \brief Headers for low-level cryptographic functions.
  **/

Index: fakepoll.h
===================================================================
RCS file: /home/or/cvsroot/src/common/fakepoll.h,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -d -r1.9 -r1.10
--- fakepoll.h	5 May 2004 01:01:34 -0000	1.9
+++ fakepoll.h	10 May 2004 07:54:13 -0000	1.10
@@ -5,6 +5,11 @@
 #ifndef __FAKEPOLL_H
 #define __FAKEPOLL_H
 
+/**
+ * \file fakepoll.h
+ * \brief Headers for fakepoll.c
+ */
+
 #include "orconfig.h"
 
 #define POLL_NO_WARN

Index: log.h
===================================================================
RCS file: /home/or/cvsroot/src/common/log.h,v
retrieving revision 1.23
retrieving revision 1.24
diff -u -d -r1.23 -r1.24
--- log.h	10 May 2004 03:53:24 -0000	1.23
+++ log.h	10 May 2004 07:54:13 -0000	1.24
@@ -10,6 +10,11 @@
 
 #ifndef __LOG_H
 
+/**
+ * \file log.h
+ * \brief Headers for log.c
+ */
+
 #ifdef HAVE_SYSLOG_H
 #include <syslog.h>
 #define LOG_WARN LOG_WARNING

Index: test.h
===================================================================
RCS file: /home/or/cvsroot/src/common/test.h,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -d -r1.12 -r1.13
--- test.h	26 Apr 2004 22:12:13 -0000	1.12
+++ test.h	10 May 2004 07:54:13 -0000	1.13
@@ -5,6 +5,11 @@
 #ifndef __TEST_H
 #define __TEST_H
 
+/**
+ * \file test.h
+ * \brief Headers for test.c
+ */
+
 #include <string.h>
 #include <stdio.h>
 

Index: torint.h
===================================================================
RCS file: /home/or/cvsroot/src/common/torint.h,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -d -r1.8 -r1.9
--- torint.h	5 May 2004 20:26:35 -0000	1.8
+++ torint.h	10 May 2004 07:54:13 -0000	1.9
@@ -2,16 +2,16 @@
 /* See LICENSE for licensing information */
 /* $Id$ */
 
-/*****
- * torint.h: Header file to define uint32_t and friends.
- *****/
+/**
+ * \file torint.h
+ * \brief Header file to define uint32_t and friends
+ **/
 
 #ifndef __TORINT_H
 #define __TORINT_H
 
 #include "orconfig.h"
 
-
 #ifdef HAVE_STDINT_H
 #include <stdint.h>
 #endif

Index: tortls.h
===================================================================
RCS file: /home/or/cvsroot/src/common/tortls.h,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -d -r1.15 -r1.16
--- tortls.h	1 May 2004 20:46:27 -0000	1.15
+++ tortls.h	10 May 2004 07:54:13 -0000	1.16
@@ -5,6 +5,11 @@
 #ifndef _TORTLS_H
 #define _TORTLS_H
 
+/**
+ * \file tortls.h
+ * \brief Headers for tortls.c
+ **/
+
 #include "../common/crypto.h"
 
 /* Opaque structure to hold a TLS connection. */

Index: util.h
===================================================================
RCS file: /home/or/cvsroot/src/common/util.h,v
retrieving revision 1.67
retrieving revision 1.68
diff -u -d -r1.67 -r1.68
--- util.h	7 May 2004 17:04:11 -0000	1.67
+++ util.h	10 May 2004 07:54:13 -0000	1.68
@@ -5,7 +5,7 @@
 /**
  * \file util.h
  * \brief Headers for util.c
- */
+ **/
 
 #ifndef __UTIL_H
 #define __UTIL_H