mhd2spdy: info in source headers

7 files changed, 21 insertions, 19 deletions

diff --git a/src/examples/mhd2spdy.c b/src/examples/mhd2spdy.c
index 10d0afd4..d921aa27 100644
--- a/src/examples/mhd2spdy.c
+++ b/src/examples/mhd2spdy.c
@@ -16,21 +16,16 @@
 */
 
 /**
- * @file structures.h
+ * @file mhd2spdy.c
+ * @brief  The main file of the HTTP-to-SPDY proxy with the 'main' function
+ *         and event loop. No threads are used.
+ *         Currently only GET is supported.
+ *         TODOs:
+ *         - non blocking SSL connect
+ *         - check certificate
  * @author Andrey Uzunov
  */
  
- /*
-  * TODOs
-  * non blocking SSL connect
-  * check certificate
-  * 
-  * 
-  * 
-  * 
-  
-  
-  */
  
 #include "mhd2spdy_structures.h"
 #include "mhd2spdy_spdy.h"
diff --git a/src/examples/mhd2spdy_http.c b/src/examples/mhd2spdy_http.c
index 2c8d4c23..4761c086 100644
--- a/src/examples/mhd2spdy_http.c
+++ b/src/examples/mhd2spdy_http.c
@@ -16,7 +16,8 @@
 */
 
 /**
- * @file structures.h
+ * @file mhd2spdy_http.c
+ * @brief  HTTP part of the proxy. libmicrohttpd is used for the server side.
  * @author Andrey Uzunov
  */
  
diff --git a/src/examples/mhd2spdy_http.h b/src/examples/mhd2spdy_http.h
index 484e86d1..78685c69 100644
--- a/src/examples/mhd2spdy_http.h
+++ b/src/examples/mhd2spdy_http.h
@@ -16,7 +16,8 @@
 */
 
 /**
- * @file structures.h
+ * @file mhd2spdy_http.h
+ * @brief  HTTP part of the proxy. libmicrohttpd is used for the server side.
  * @author Andrey Uzunov
  */
  
diff --git a/src/examples/mhd2spdy_spdy.c b/src/examples/mhd2spdy_spdy.c
index 9c5b94f5..8640df35 100644
--- a/src/examples/mhd2spdy_spdy.c
+++ b/src/examples/mhd2spdy_spdy.c
@@ -1,5 +1,4 @@
 /*
- * Spdylay - SPDY Library
  *
  * Copyright (c) 2012 Tatsuhiro Tsujikawa
  *
@@ -24,7 +23,10 @@
  */
 
 /**
- * @file spdy.c
+ * @file mhd2spdy_spdy.c
+ * @brief  SPDY part of the proxy. libspdylay is used for the client side.
+ *         The example spdycli.c from spdylay was used as basis;
+ *         however, multiple changes were made.
  * @author Tatsuhiro Tsujikawa
  * @author Andrey Uzunov
  */
diff --git a/src/examples/mhd2spdy_spdy.h b/src/examples/mhd2spdy_spdy.h
index 04fcf9d2..fa27e7f6 100644
--- a/src/examples/mhd2spdy_spdy.h
+++ b/src/examples/mhd2spdy_spdy.h
@@ -16,7 +16,8 @@
 */
 
 /**
- * @file spdy.h
+ * @file mhd2spdy_spdy.h
+ * @brief  SPDY part of the proxy. libspdylay is used for the client side.
  * @author Andrey Uzunov
  */
  
diff --git a/src/examples/mhd2spdy_structures.c b/src/examples/mhd2spdy_structures.c
index f7d54c4c..da29581c 100644
--- a/src/examples/mhd2spdy_structures.c
+++ b/src/examples/mhd2spdy_structures.c
@@ -16,7 +16,8 @@
 */
 
 /**
- * @file structures.h
+ * @file mhd2spdy_structures.h
+ * @brief  Common functions, macros.
  * @author Andrey Uzunov
  */
  
diff --git a/src/examples/mhd2spdy_structures.h b/src/examples/mhd2spdy_structures.h
index 0900964f..6d6d9769 100644
--- a/src/examples/mhd2spdy_structures.h
+++ b/src/examples/mhd2spdy_structures.h
@@ -16,7 +16,8 @@
 */
 
 /**
- * @file structures.h
+ * @file mhd2spdy_structures.h
+ * @brief  Common structures, functions, macros and global variables.
  * @author Andrey Uzunov
  */
 #ifndef STRUCTURES_H