Add missing inline documentation for android code (#8893)

# Objective

- Document android code that is currently causing clippy warnings due to
not being documented

## Solution

- Document the two previously undocumented items
This commit is contained in:
Niklas Eicker 2023-06-20 00:49:05 +02:00 committed by GitHub
parent f63656051a
commit 96b9b6c8ad
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 2 additions and 0 deletions

View file

@ -22,6 +22,7 @@ pub struct AndroidAssetIo {
} }
impl AndroidAssetIo { impl AndroidAssetIo {
/// Creates a new [`AndroidAssetIo`] at the given root path
pub fn new<P: AsRef<Path>>(path: P) -> Self { pub fn new<P: AsRef<Path>>(path: P) -> Self {
AndroidAssetIo { AndroidAssetIo {
root_path: path.as_ref().to_owned(), root_path: path.as_ref().to_owned(),

View file

@ -59,6 +59,7 @@ use crate::converters::convert_winit_theme;
#[cfg(target_arch = "wasm32")] #[cfg(target_arch = "wasm32")]
use crate::web_resize::{CanvasParentResizeEventChannel, CanvasParentResizePlugin}; use crate::web_resize::{CanvasParentResizeEventChannel, CanvasParentResizePlugin};
/// [`AndroidApp`] provides an interface to query the application state as well as monitor events (for example lifecycle and input events)
#[cfg(target_os = "android")] #[cfg(target_os = "android")]
pub static ANDROID_APP: std::sync::OnceLock<AndroidApp> = std::sync::OnceLock::new(); pub static ANDROID_APP: std::sync::OnceLock<AndroidApp> = std::sync::OnceLock::new();