From dce94dcac3043d65ee5496e73e749884727bb272 Mon Sep 17 00:00:00 2001
From: jackfiled <xcrenchangjun@outlook.com>
Date: Wed, 4 May 2022 16:24:05 +0800
Subject: [PATCH] =?UTF-8?q?=E6=B7=BB=E5=8A=A0Doxygen=E6=B3=A8=E9=87=8A?=
 =?UTF-8?q?=E7=9A=84=E7=A4=BA=E4=BE=8B?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 lib/example.c | 5 +++++
 main.c        | 9 +++++++++
 2 files changed, 14 insertions(+)

diff --git a/lib/example.c b/lib/example.c
index 219d245..54f8b65 100644
--- a/lib/example.c
+++ b/lib/example.c
@@ -3,6 +3,11 @@
 //
 #include "example.h"
 
+/**
+ * @brief 在stdin打印一个字符串
+ * 
+ * @param str 指向需要打印的字符串指针
+ */
 void print(char* str)
 {
     printf("%s", str);
diff --git a/main.c b/main.c
index 4689e2f..dc1bddf 100644
--- a/main.c
+++ b/main.c
@@ -1,7 +1,16 @@
 #include "example.h"
 
+/**
+ * @brief 程序的主函数
+ * 
+ * @return int 程序结束的状态，0表示成功
+ */
 int main()
 {
+    /**
+     * @brief 需要输出的字符串
+     * 
+     */
     char* string = "Good morning!\n";
     print(string);
     return 0;