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
This commit is contained in:
TianlongLiang
2024-04-11 07:50:08 +08:00
committed by GitHub
parent 8756d29e19
commit 4e634bed3f
6 changed files with 30 additions and 0 deletions

View File

@ -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

View File

@ -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

View File

@ -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_

View File

@ -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_

View File

@ -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