From 96b9b6c8ad9532062722b41e8c7bd24256927258 Mon Sep 17 00:00:00 2001
From: Niklas Eicker <git@nikl.me>
Date: Tue, 20 Jun 2023 00:49:05 +0200
Subject: [PATCH] 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
---
 crates/bevy_asset/src/io/android_asset_io.rs | 1 +
 crates/bevy_winit/src/lib.rs                 | 1 +
 2 files changed, 2 insertions(+)

diff --git a/crates/bevy_asset/src/io/android_asset_io.rs b/crates/bevy_asset/src/io/android_asset_io.rs
index a5e91bb8be..a90187b8f2 100644
--- a/crates/bevy_asset/src/io/android_asset_io.rs
+++ b/crates/bevy_asset/src/io/android_asset_io.rs
@@ -22,6 +22,7 @@ pub struct AndroidAssetIo {
 }
 
 impl AndroidAssetIo {
+    /// Creates a new [`AndroidAssetIo`] at the given root path
     pub fn new<P: AsRef<Path>>(path: P) -> Self {
         AndroidAssetIo {
             root_path: path.as_ref().to_owned(),
diff --git a/crates/bevy_winit/src/lib.rs b/crates/bevy_winit/src/lib.rs
index 85f315819f..900d4126b4 100644
--- a/crates/bevy_winit/src/lib.rs
+++ b/crates/bevy_winit/src/lib.rs
@@ -59,6 +59,7 @@ use crate::converters::convert_winit_theme;
 #[cfg(target_arch = "wasm32")]
 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")]
 pub static ANDROID_APP: std::sync::OnceLock<AndroidApp> = std::sync::OnceLock::new();