Adding documentation for factory (#1936)

microsoft · Jul 22, 2022 · a84560c · a84560c
1 parent b71db73
commit a84560c
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/crates/libs/windows/src/core/factory_cache.rs b/crates/libs/windows/src/core/factory_cache.rs
@@ -47,7 +47,8 @@ impl<C: RuntimeName, I: Interface> FactoryCache<C, I> {
 // This is safe because `FactoryCache` only holds agile factory pointers, which are safe to cache and share between threads.
 unsafe impl<C, I> ::core::marker::Sync for FactoryCache<C, I> {}
 
-/// Attempts to load the factory interface for the given WinRT class
+/// Attempts to load the factory object for the given WinRT class.
+/// This can be used to access COM interfaces implemented on a Windows Runtime class factory.
 pub fn factory<C: RuntimeName, I: Interface>() -> Result<I> {
     let mut factory: Option<I> = None;
     let name = HSTRING::from(C::NAME);

diff --git a/crates/libs/windows/src/core/mod.rs b/crates/libs/windows/src/core/mod.rs
@@ -38,7 +38,6 @@ pub use compose::*;
 pub(crate) use delay_load::*;
 pub use error::*;
 pub use event::*;
-#[doc(hidden)]
 pub use factory_cache::*;
 #[doc(hidden)]
 pub use generic_factory::*;