diff --git a/android-activity/src/lib.rs b/android-activity/src/lib.rs index 448fc57..f38fc67 100644 --- a/android-activity/src/lib.rs +++ b/android-activity/src/lib.rs @@ -35,6 +35,18 @@ //! marshalled between the Java thread that owns the `Activity` and the native //! thread that runs the `android_main()` code. //! +//! # Cheaply Clonable [`AndroidApp`] +//! +//! [`AndroidApp`] is intended to be something that can be cheaply passed around +//! by referenced within an application. It is reference counted and can be +//! cheaply cloned. +//! +//! # `Send` and `Sync` [`AndroidApp`] +//! +//! Although an [`AndroidApp`] implements `Send` and `Sync` you do need to take +//! into consideration that some APIs, such as [`AndroidApp::poll_events()`] are +//! explicitly documented to only be usable from your `android_main()` thread. +//! //! # Main Thread Initialization //! //! Before `android_main()` is called, the following application state @@ -489,6 +501,18 @@ bitflags! { /// marshalled between the Java thread that owns the `Activity` and the native /// thread that runs the `android_main()` code. /// +/// # Cheaply Clonable [`AndroidApp`] +/// +/// [`AndroidApp`] is intended to be something that can be cheaply passed around +/// by referenced within an application. It is reference counted and can be +/// cheaply cloned. +/// +/// # `Send` and `Sync` [`AndroidApp`] +/// +/// Although an [`AndroidApp`] implements `Send` and `Sync` you do need to take +/// into consideration that some APIs, such as [`AndroidApp::poll_events()`] are +/// explicitly documented to only be usable from your `android_main()` thread. +/// #[derive(Debug, Clone)] pub struct AndroidApp { pub(crate) inner: Arc>,