From 4e634bed3f979f8cea6444cf771701a660ca1112 Mon Sep 17 00:00:00 2001
From: TianlongLiang <111852609+TianlongLiang@users.noreply.github.com>
Date: Thu, 11 Apr 2024 07:50:08 +0800
Subject: [PATCH] Add necessary comments for doxygen  (#3299)

- Add necessary comments for doxygen to generate API documentation
- Update README.md to add a link for End-user APIs documentation
---
 README.md                        | 1 +
 core/iwasm/include/aot_export.h  | 6 ++++++
 core/iwasm/include/gc_export.h   | 6 ++++++
 core/iwasm/include/lib_export.h  | 5 +++++
 core/iwasm/include/wasm_c_api.h  | 6 ++++++
 core/iwasm/include/wasm_export.h | 6 ++++++
 6 files changed, 30 insertions(+)

diff --git a/README.md b/README.md
index cb91c22c..5a53536a 100644
--- a/README.md
+++ b/README.md
@@ -67,6 +67,7 @@ The following platforms are supported, click each link below for how to build iw
 - [Port WAMR to a new platform](./doc/port_wamr.md)
 - [VS Code development container](./doc/devcontainer.md)
 - [Samples](./samples) and [Benchmarks](./tests/benchmarks)
+- [End-user APIs documentation](https://bytecodealliance.github.io/wamr.dev/apis/)
 
 
 
diff --git a/core/iwasm/include/aot_export.h b/core/iwasm/include/aot_export.h
index c1a03d86..d06fef1d 100644
--- a/core/iwasm/include/aot_export.h
+++ b/core/iwasm/include/aot_export.h
@@ -3,6 +3,12 @@
  * SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
  */
 
+/**
+ * @file   aot_export.h
+ *
+ * @brief  This file defines the exported AOT compilation APIs
+ */
+
 #ifndef _AOT_EXPORT_H
 #define _AOT_EXPORT_H
 
diff --git a/core/iwasm/include/gc_export.h b/core/iwasm/include/gc_export.h
index 3eb88dba..777551ed 100644
--- a/core/iwasm/include/gc_export.h
+++ b/core/iwasm/include/gc_export.h
@@ -3,6 +3,12 @@
  * SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
  */
 
+/**
+ * @file   gc_export.h
+ *
+ * @brief  This file defines the exported GC APIs
+ */
+
 #ifndef _GC_EXPORT_H
 #define _GC_EXPORT_H
 
diff --git a/core/iwasm/include/lib_export.h b/core/iwasm/include/lib_export.h
index e4829e4f..0ca668f5 100644
--- a/core/iwasm/include/lib_export.h
+++ b/core/iwasm/include/lib_export.h
@@ -3,6 +3,11 @@
  * SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
  */
 
+/**
+ * @file   lib_export.h
+ *
+ */
+
 #ifndef _LIB_EXPORT_H_
 #define _LIB_EXPORT_H_
 
diff --git a/core/iwasm/include/wasm_c_api.h b/core/iwasm/include/wasm_c_api.h
index 0d62c275..63d18f3a 100644
--- a/core/iwasm/include/wasm_c_api.h
+++ b/core/iwasm/include/wasm_c_api.h
@@ -1,5 +1,11 @@
 // WebAssembly C API
 
+/**
+ * @file   wasm_c_api.h
+ *
+ * @brief  This file defines the WebAssembly C APIs
+ */
+
 #ifndef _WASM_C_API_H_
 #define _WASM_C_API_H_
 
diff --git a/core/iwasm/include/wasm_export.h b/core/iwasm/include/wasm_export.h
index e40e9488..bc43ea0b 100644
--- a/core/iwasm/include/wasm_export.h
+++ b/core/iwasm/include/wasm_export.h
@@ -3,6 +3,12 @@
  * SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
  */
 
+/**
+ * @file   wasm_export.h
+ *
+ * @brief  This file defines the exported common runtime APIs
+ */
+
 #ifndef _WASM_EXPORT_H
 #define _WASM_EXPORT_H