Update docs

ValerioL29 · Jun 8, 2022 · 08d695b · 08d695b
1 parent 75ca2ce
commit 08d695b
Show file tree

Hide file tree

Showing 9 changed files with 15 additions and 16 deletions.
diff --git a/README.md b/README.md
@@ -5,7 +5,7 @@
 
 > Goals -
 >
-> 1. Receive Email from pop3 server.
+> 1. Communicate with pop3 server.
 > 2. Store Email in `*.eml` format.
 > 3. Friendly user interface and good interactive user experience.
 
@@ -36,16 +36,16 @@ Sent Me Email
 │   │   ├── Socket.h
 │   │   └── socket.cpp
 │   └── config.h
+│   └── conio.h
 ├── main.cpp
 └── resources
-    └── test.eml
 ```
 
 ## How to Run this project
 
 1. Install `cmake 3.0.0` or higher version
 2. Execute `cmake --build build` to build
-3. Run `./build/pop3-client` to start client application, enjoy!
+3. Run `build/pop3-client` to start client application, enjoy!
 
 ## Function Requirements
 
@@ -55,11 +55,11 @@ Sent Me Email
 - [x] Guide user to login and show information about their mails
 - [x] Display prompt characters such as `mypop >`
 - [x] Can display content of mails in terminal
-- [ ] The communication procedure can be captured by Wireshark
+- [x] The communication procedure can be captured by Wireshark
 
 #### Advanced
 
-- [ ] Login with implicit password (replace your password by `****`)
+- [x] Login with implicit password (replace your password by `****`)
 - [x] Can download mails and save them only on local machine  (remove from remote server)
 - [x] Provide function "Display by subject"
 - [x] Provide function "Search text in all mails"
diff --git a/lib/Error/Error.h b/lib/Error/Error.h
@@ -1,8 +1,9 @@
 /**
  * @brief Error handling and reporting tools
  *
- * @file error.h
+ * @file Error.h
  * @author Jiacheng Li (cheng2029@foxmail.com)
+ * @author Zhenglin Xian (617454220@qq.com)
  * 
  */
 

diff --git a/lib/Error/error.cpp b/lib/Error/error.cpp
@@ -3,7 +3,7 @@
  *
  * @file error.cpp
  * @author Jiacheng Li (cheng2029@foxmail.com)
- * 
+ * @author Zhenglin Xian (617454220@qq.com)
  */
 
 #include "../config.h"

diff --git a/lib/Pop3Session/Pop3Session.h b/lib/Pop3Session/Pop3Session.h
@@ -3,7 +3,7 @@
  *
  * @file Pop3Session.h
  * @author Jiacheng Li (cheng2029@foxmail.com)
- * 
+ * @author Zhenglin Xian (617454220@qq.com)
  */
 
 #ifndef _POP3SESSION__H

diff --git a/lib/Pop3Session/pop3session.cpp b/lib/Pop3Session/pop3session.cpp
@@ -3,7 +3,7 @@
  *
  * @file pop3session.cpp
  * @author Jiacheng Li (cheng2029@foxmail.com)
- * 
+ * @author Zhenglin Xian (617454220@qq.com)
  */
 
 #include <iostream>

diff --git a/lib/Socket/Socket.h b/lib/Socket/Socket.h
@@ -1,9 +1,9 @@
 /**
  * @brief BSD sockets API adapter.
  *
- * @file socket.h
+ * @file Socket.h
  * @author Jiacheng Li (cheng2029@foxmail.com)
- * 
+ * @author Zhenglin Xian (617454220@qq.com)
  */
 
 #ifndef _SOCKET__H

diff --git a/lib/Socket/socket.cpp b/lib/Socket/socket.cpp
@@ -3,7 +3,7 @@
  *
  * @file socket.cpp
  * @author Jiacheng Li (cheng2029@foxmail.com)
- * 
+ * @author Zhenglin Xian (617454220@qq.com)
  */
 
 #include "../config.h"

diff --git a/lib/config.h b/lib/config.h
@@ -3,12 +3,10 @@
  *
  * @file config.h
  * @author Jiacheng Li (cheng2029@foxmail.com)
+ * @author Zhenglin Xian (617454220@qq.com)
  * 
  *  Global configuration macros and values.
  *
- * @warning Beware of what you put in here and how do you
- *          name it! This file is global and the names can
- *          interfere with those defined anywhere in the program!
  */
 
 #ifndef _CONFIG__H

diff --git a/main.cpp b/main.cpp
@@ -1,8 +1,8 @@
 /**
  * @brief CLI part for the client
  *
- * @file CLI.h
  * @author Jiacheng Li (cheng2029@foxmail.com)
+ * @author Zhenglin Xian (617454220@qq.com)
  *
  */
 #include <iostream>