doxygen markup for common/*.h

svn:r1840

8 files changed, 31 insertions, 6 deletions

diff --git a/src/common/aes.h b/src/common/aes.h
index 2edbb8818..3c63a0e4f 100644
--- a/src/common/aes.h
+++ b/src/common/aes.h
@@ -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;
diff --git a/src/common/crypto.h b/src/common/crypto.h
index 019a536a4..2b752af37 100644
--- a/src/common/crypto.h
+++ b/src/common/crypto.h
@@ -3,7 +3,7 @@
 /* $Id$ */
 
 /**
- * \file crypto.c
+ * \file crypto.h
  *
  * \brief Headers for low-level cryptographic functions.
  **/
diff --git a/src/common/fakepoll.h b/src/common/fakepoll.h
index 783aff0c4..bf11237dd 100644
--- a/src/common/fakepoll.h
+++ b/src/common/fakepoll.h
@@ -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
diff --git a/src/common/log.h b/src/common/log.h
index 5f900d320..fa830a9b4 100644
--- a/src/common/log.h
+++ b/src/common/log.h
@@ -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
diff --git a/src/common/test.h b/src/common/test.h
index 15615f399..81d54b88f 100644
--- a/src/common/test.h
+++ b/src/common/test.h
@@ -5,6 +5,11 @@
 #ifndef __TEST_H
 #define __TEST_H
 
+/**
+ * \file test.h
+ * \brief Headers for test.c
+ */
+
 #include <string.h>
 #include <stdio.h>
 
diff --git a/src/common/torint.h b/src/common/torint.h
index ce2d067ab..07e291e51 100644
--- a/src/common/torint.h
+++ b/src/common/torint.h
@@ -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
diff --git a/src/common/tortls.h b/src/common/tortls.h
index b69e951bb..f9ffb0edc 100644
--- a/src/common/tortls.h
+++ b/src/common/tortls.h
@@ -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. */
diff --git a/src/common/util.h b/src/common/util.h
index ed01e6573..04811abfa 100644
--- a/src/common/util.h
+++ b/src/common/util.h
@@ -5,7 +5,7 @@
 /**
  * \file util.h
  * \brief Headers for util.c
- */
+ **/
 
 #ifndef __UTIL_H
 #define __UTIL_H