Skip to content

Commit 1c5e4ff

Browse files
committed
add documentation
1 parent 18d00ce commit 1c5e4ff

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

crates/libs/core/src/api/mod.rs

+5
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,12 @@ use windows_core::{Interface, Param};
1515

1616
lazy_static::lazy_static! {
1717
static ref LIB_TABLE: LibTable = LibTable::create();
18+
/// All SF APIs entrypoints needed for mssf.
19+
/// These APIs are lazy loaded at the first time use after app starts.
1820
pub static ref API_TABLE: ApiTable = ApiTable::create(&LIB_TABLE);
1921
}
2022

23+
/// Contains all the SF shared libs needs to be loaded for mssf.
2124
pub struct LibTable {
2225
fabric_runtime: libloading::Library,
2326
fabric_common: libloading::Library,
@@ -43,6 +46,8 @@ fn load_fn<T>(lib: &'static libloading::Library, name: &str) -> libloading::Symb
4346
unsafe { lib.get(name.as_bytes()) }.unwrap_or_else(|e| panic!("cannot load fn {name} :{e}"))
4447
}
4548

49+
/// Contains all SF APIs loaded from SF libs needed for mssf.
50+
/// More APIs can be added here when mssf needs them.
4651
pub struct ApiTable {
4752
fabric_get_last_error_message_fn: libloading::Symbol<
4853
'static,

crates/libs/core/src/lib.rs

+1
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
2020
// lib that contains all common extensions for the raw fabric apis.
2121

22+
// SF lib entrypoint apis.
2223
pub mod api;
2324
pub use api::API_TABLE;
2425
#[cfg(feature = "tokio_async")]

0 commit comments

Comments
 (0)