doxygen markup for common/*.h

svn:r1840

diff --git a/src/common/aes.h b/src/common/aes.h
index 2edbb8818c9596723b0af8b54b729c2d7da18ff9..3c63a0e4f2704419084ea85c032d280aa271f711 100644 (file)
--- 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 019a536a4c5eb81b5125549b535854f82f7c71e5..2b752af3727016a3cb12b49c4e1650a194790e83 100644 (file)
--- 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 783aff0c42239fed8c2d3f203aa19f00c45609a7..bf11237dd1803623cd96ae0880309deae2ec7d8f 100644 (file)
--- 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 5f900d320edc0f828268a52dd6ef99e49d376e99..fa830a9b46db1624b92c585e48e6d2aefe8f040d 100644 (file)
--- 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 15615f399101b46154df028faf973a2f224376b5..81d54b88f39e107fa65907acc5299a9fb9ca737b 100644 (file)
--- 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 ce2d067ab43133e2eaa1f76d45097a6f1784aa82..07e291e51ed2ed9d9efce0f3d69c5409d5adecec 100644 (file)
--- 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 b69e951bbe86531f212d9cdf79404d4c2d5ae384..f9ffb0edc0c13bf5b9c015450031bba75154f00b 100644 (file)
--- 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 ed01e657328f2a68cfe576aa95a9407b303e55f0..04811abfa13a1497ab7fc61d746d5dbb943a4713 100644 (file)
--- 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