Mauricio Donatti / HTTP_SERVER

Simple HTTP Server with one page index.html stored inside MBED as char vector and javascript to update a table content

Fork of HTTP_SERVER by Akifumi Takahashi

Diff: HTTP_SERVER.h

Revision:
9:84aca9965f9f
Parent:
0:cc483bea4fe3
Child:
12:cbf97b865d76
--- a/HTTP_SERVER.h	Mon Nov 28 08:43:26 2016 +0000
+++ b/HTTP_SERVER.h	Tue Dec 06 07:29:01 2016 +0000
@@ -12,23 +12,25 @@
 enum PortNum {
     TCP_PORT = 80
 };
-
+/** HttpServer class
+ *
+ * This is the class to make a mbed a simple HTTP Server.
+ */
 class HttpServer
 {
 public:
     HttpServer();
     ~HttpServer();
-    /**
-     *  HTTP SERVER Initialization.
-     *  This is called in the Constructor.
-     *  You don't have to use but can call this if you have some reasons to init the server.
+    /** HTTP SERVER Initialization.
+     *
+     *  This function should be called first of all.
      *  @return result of init() as boolean.
      *  @retval TRUE SACCESS
      *  @retval FALSE
      */
     bool init();
-    /**
-     *  Run the surver service while listening flag is true.
+    /** Run the surver service while listening flag is true.
+     *
      *  @return state ending.
      *  @retval TRUE at error end.
      *  @retval FALSE at normal end.